Getting Started
Environments
We provide two environments, Production and Sandbox, to allow developers to develop, test, and deploy their applications.
Production Environment is the live environment where developers can send real-time requests to the API. This environment is intended to be used in the final stages of development when the application is ready for deployment.
Sandbox Environment is the testing environment where developers can build and test the application. This environment allows developers to make API requests without affecting the production environment. It's ideal for testing API requests.
Access Token
An access token is an authentication code required to access the API. The code will be available to the user after registering an account on https://www.useme.com/. Please contact our support team so we can enable the API access. Then, to find your token, log in to your account and go to https://www.useme.com/users/api-access-token/ where you'll see your access token.
:::highlight blue
The token for the sandbox environment may be different from the token for the production environment
:::
:::highlight red
The access token should never be shared publicly or stored in plain text or insecure files. Doing so may put your account and data at risk. Make sure your token is confidential.
:::
Authorization
To access the API you need to enter your token as an authorization header when making an API request. This will allow our API to identify and authenticate you.
'Authorization: Token <your api token>'
Versioning
We currently have one version of the API, which is 1.0. To access the API, the version needs to be specified in the URL. For example: https://dev.api.useme.com/1.0/.... This allows backward compatibility and future updates without breaking existing integrations.
Changelog
Version 1.0
- Added endpoint for creating freelancers.
- Added endpoint for retrieving categories and subcategories for deals.
- Added endpoint for creating deals.
- Added endpoint for uploading files to close deals.