API access
Proper Payments uses API keys to authenticate requests. You can view and manage your API keys in the Proper platform.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Create an API key
Proper authenticates your API requests using your account’s API keys. If a request doesn’t include a valid key, Proper returns an invalid request error. If a request includes a deleted key, Proper returns an authentication error.
We recommend creating restricted API keys and limit data acess to individual resources.
Login and select the account
Make sure you are viewing the account you want to generate an API key for.
Navigate to Settings → API keys
Under Settings you find API keys. Here are the existing keys listed, view request logs and make new keys.
Create new key
Make sure to give your API key a meaningful name and the necessary permissions. You can always update the permissions later.
Multiple accounts
Proper generate a unique ID for each legal entity – we call this an account. When requesting the API you need an API key per account that you want to access.
Follow the steps above to optain an API Key for each of your accounts.
Restricted keys
For optimal security, generate restricted API keys with precise access controls. For instance, when syncing with your accounting system, use a key that exclusively permits write operations, preventing unauthorized modifications or access to unrelated data.