Frequently Asked Questions
Learn how to start using our product. Understand the key features.
What is an API page?
The API page provides comprehensive information about APIs and will enable potential users to understand the API's functional and technical profile. Based on this information, users can decide whether the API is relevant and whether they should subscribe to it.
How do I update my API Profile Pages/Version?
To update your API Profile Page, click on the "My API" sub-menu provided at the Sandbox tab. Select the API that you would like to update and click on the edit button respectively. Now, you can edit the information on the API profile page respectively. Your changes will be approved by the APIX admin before being published in the profile page.
To update the version, click the "API Publisher" sub-menu in the "Sandbox" tab. Select the relevant API you would like to update. Then navigate to the API console and select the version of the API you would like to update. Click the "Edit" button and update the relevant information. Alternatively, you can add a new API version by clicking the "Add Version" button.
Why aren't my updates shown on the API Page?
Any update made on the APIs will only be visible once the APIX Admin has approved the changes.
Where can I get more support for APIs listed on the marketplace?
You can find the contact details of the API publishers in the Directory (Marketplace).
Can I upload my non-disclosure agreement (NDA) or service-level agreement (SLA) on the platform?
Yes, you can upload your Non-Disclosure Agreement (NDA) or Service-Level Agreement (SLA) directly.
What is the API Console on APIX?
The API Console is where you can view and try out the Endpoints for a particular API.
How can I experiment with APIs using the API Console?
You can try out each API after subscribing to their own console. Furthermore, using the Sandbox, you can integrate multiple APIs and access your dataset together to quickly implement a MVP.
How do I access and utilise the API Console for testing?
Search for the API you are looking for under Marketplace. Once displayed, click on the API tile and you will be redirected to the API console. If you subscribe to the API, you will be given more options to try out. Follow the instructions provided by the publisher on how to test the API.
How can I update my API Parameter documentation?
You will have to externally modify your Swagger file and re-upload the updated version onto the portal.
My API requires a specific authentication token. How do I provide it to the user?
Users can access your APIs based on the API credentials that were defined during onboarding of the API. Based on this, users will be able to view the respective access token in the API. That is,
- External Credentials - Users will be provided with the URL in the "APIX Access Token" tab in the API detail page, where the token can be generated from.
- Shared Credentials - Users will be provided with the defined pre-generated token in the "APIX Access Token" tab in the API detail page.
Can't find what you are looking for?
We're here to answer your questions.
Send our support team a note at
support@apixplatform.com