Environments#
Useme provides separate production and sandbox environments.The Production environment processes live data and should be used by deployed integrations.The Sandbox environment is intended for development and testing. It allows you to verify your integration without affecting production data.https://useme.com/api/2.0/
https://sandbox.useme.com/api/2.0/
Access token#
Every API request must be authenticated with an access token assigned to a Useme employer account.To obtain a production token:1.
Register or log in to your account at useme.com. 2.
Contact the Useme support team to request API 2.0 access.
Production and sandbox use separate access tokens. A token issued in one environment cannot be used in the other.
Never expose an access token publicly or store it in source code or other insecure files. Treat it as a secret because it grants access to your account's API data.
Authorization#
Include the access token in the Authorization header of every API request. The authentication scheme must be Token:Requests without a valid token are rejected. Access to API 2.0 also requires the corresponding permission to be enabled for the authenticated account.Versioning#
The API version is part of every endpoint URL. This documentation covers version 2.0, available under:https://useme.com/api/2.0/
/api/1.0/ for integrations that use its endpoint set. When implementing a new integration based on this documentation, use /api/2.0/.Changelog#
Version 2.0#
Added an endpoint for retrieving the category tree.
Added deal creation with automatic detection or registration of the contractor.
Added an endpoint for listing deals associated with the authenticated employer.
Added retrieval of deal details by payment token, including status and billing information.
Introduced a consistent response structure for API 2.0 endpoints.
