Introduction
Example section for showcasing API endpoints
Welcome
Welcome to the Portable API documentation. Our API is purpose-built for application integrators, enabling them to seamlessly incorporate our services into their platform, ensuring a fully branded experience for their users.
The base URL for all the described endpoints is https://api.portable.io
The Portable API is a RESTful API, and follows the principles of Representational State Transfer (REST) for creating, updating, reading, and deleting resources.
Authentication
An API token is a secure and unique identifier that grants you access to our API. This token is required for all API calls and must be kept confidential to prevent unauthorized access to your account.
Obtaining the Bearer Token
Access to the Portable API is provided to our customers in our Clouse plan and up. If you are on this plan, you can obtain your API token from the Portable App.
If you face any issues, please contact our support team at support@portable.io and someone will reach out to you shortly.
Using the Bearer Token
When making requests to the Portable API, include your API token in the Authorization header of your HTTP request. The
format of the header should be as follows:
Authorization: Bearer <Your-API-Token>
Replace <Your-API-Token> with your actual API token.
To maintain the security of your API interactions, it’s crucial to keep your API token secure and never share it publicly or expose it in client-side code. Treat your API token with the same level of security as you would a password.
Revoking Access
In the event that you need to revoke API access or suspect unauthorized use of your token, use the Revoke button in the Portable App to invalidate your token.