Get402 Client Elixir

Build Paid APIs with Ease. This library simplifies offering of APIs that can be accessed only via micropayments

Installation

Usage

See https://get402.com/docs for complete documentation

You may import the entire library or load only specific objects as needed

Authentication

Your Get402 API is identified by a public/private key pair where the public address is used to identify your API and the private key is used to sign requests to get402.com.

Using Existing API Private Key

Generating A New API PrivateKey

One you load your app using its private key there is no more work to do, all signing of requests is handled automatically by the library.

Get Client API Key Balance

All clients start with a balance of zero credits available, which can be queried any time

Creating a New Client

Getting Balance For An Existing Client

Charge Client API Key

When a client uses your API you should charge their API key which reduces their available balance of credits.

If their balance of credits goes to zero you will receive an error including a PaymentRequired request with details on purchasing additional credits. If you do not want to receive an error here always check the balance first.

Add Funds To Client API Key

Getting a Payment Request To Buy More Credits

To purchase additional credits simply request a new payment template for any number of credits. You will receive a standard payment request which wallets know how to fulfill.

Using Client Key To Purchase More Credits Directly

Since client API keys are actually public/private key pairs capable of holding funds directly, this library provides a utility for purchasing new credits using the client private key directly. First you must load your client funds by sending satoshis to the client identifier address. Once funds arrive they will be available for purchasing credits.

Once payment is sent your client API key will immediately be credited with additional credits


## Development & Testing

mix compile

To run the tests you must set `GET402_PRIVATE_KEY` environment variable either in the shell or a `.env` file

mix test

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/get402](https://hexdocs.pm/get402).