README.md

ALMA PHP CLI

This project based on alma-php-client allow you to contact Alma API endpoints with different API keys for different environments (e.g. live & test) or projects - just like stripe-cli does.

Tags: payments, payment gateway, ecommerce, e-commerce, alma, monthly payments, split payments, api, cli, alma-cli, command-line-interface

Installation

• git clone
• composer install (@see get composer)

Usage

1. Put your ALMA_API_KEY in a .env.*.local file
   Where * define your environment & can be every word with only [a-Z] characters
2. Optionally change alma api target by declaring ALMA_API_MODE in your .env.*.local file (default is test)
   You can find all default values in the .env file
3. Launch command as described bellow
   Where myenvtest => .env.myenvtest.local
   (the file containing ALMA_API_KEY="sk_test_xxxxx" for example)

   php bin/console --env myenvtest alma:merchant:get
   

Available commands

• alma:merchant:get
• alma:eligibility:get
• alma:payment:create
• alma:payment:get
• alma:accounting-transactions:get

You can found more about options & arguments with --help option (ex: console alma:<command> --help)

Dynamic environments & live write limitations

To manage many env (merchants, live, test, dev) you just have to:

1. copy .env file to .env.<merch_name>[live|test|dev].local
2. remove lines before ALMA_ variables
3. update ALMA_API_KEY at least (and other variable if needed)
4. launch your command with --env OR WITHOUT
   • if --env option is not provided: interactive select list with <mech_name>-[live|test|dev] will be purposed before launch command
   • if ALMA_API_KEY is not found: command will be failed
   • if ALMA_API_KEY is something like sk_live_*** and we are in write context (alma:payment:create for example): interactive confirmation will be requested (until you add --force-live-env option)

TODO

• Auto-wiring commands into Kernel.php
  based on Alma api doc / \Alma\API\Client available endpoints.