Next, enter billing and payment information. After all relevant information is entered, you will need to scroll down to declare your API registration.
After all your information is entered correctly, click on the “Submit” button. If any field has incorrect information, it will be highlighted in red and display the current error underneath. You will need to fill in any fields that return this error before submitting the form.
If each field has been correctly entered, then this page will be displayed:
Once your purchase has been completed, your new plan will appear on the settings page with all the current details. You are now ready to query the supply API. Any supply scope application with a part limit of 1000, is treated as a ‘demo application’. These applications allow you to try all features, including Enterprise features, and the returned parts from the supply API do not count towards the plan.
Creating an Application
In order to use your plan you need an application. If you haven't already created one it's easy.
On the sidebar located on the left-hand-side of the screen, click on the “Applications” button. This will redirect you to the application page.
To create a new application, click on the “Create App” button.
Enter some details for your application. Ensure that the Supply scope is selected so the application will be able to access the supply API. You can also choose to access the design API by selecting the design scope as well. Once completed, click on the “Next” button.
Once this is checked, click on the “Create” button to create the application.
You will then be redirected to your new application.
Identifying the Application linked to your Plan
The application page gives you details about your new application. By clicking on the “Applications” button, you will be able to view all your applications, or you can click on the arrow next to the application name (“Test” in this case), located at the top of the screen.
The "Applications" page will display all active applications.
The applications with the plan-linked badge title, will use the plan you have purchased. Any other applications you might have will use the free trial 1000 returned parts a month plan. To create another application, you can re-run the same method that was used to create the first application, providing a different name.
Making a Supply Query
Once you have a plan linked to your application, you can begin to use it and query the supply API. To make a supply query using your plan, first you will need to click on the “Details” button for the application you want to use. This example uses the application called “Test” which used the 50,000 returned parts per month.
After click on the “Details” button you will be redirected to your application. In here you are able to use the built in IDE to query the Supply API. Click on the “IDE” button located near the top of the page.
Once you reach this page, you will need to click on the “Part Search” button.
You will be able to query the supply API from this page. Before running the query, you can easily alter it by editing the code.
Exploring the Data Model
To further explore our data model and IDEs see the FAQs here. This page has all possible fields you are able to query. Once you have edited your IDE, you can run the query by clicking the green play button located at the top of the IDE. This example uses the query that is automatically located in the IDE.
That’s it, you have successfully queried the Supply API. Once you have run the query, all returned information will be located on the right of your query. As well as information being returned to you, your returned part limit will be used, depending on how many results are returned. To check your part limit, click the “Dashboard” button to return to your dashboard.
Your current part object usage will increase for the application you just used. In this example, you can see that the query using the application called “Test” returned four part objects; therefore this month’s usage has increased by four.
That’s how easy it is to connect with the powerful Nexar Supply API!