Once you have successfully logged into your dashboard, you are ready to subscribe to a paid plan with optional features and unleash the Supply API. This guide shows you how to easily set-up a plan and use an application to query the API.
Signing up to a Plan
Click on the “Go to plan” button in your dashboard, which is located under “Supply Scope Summary”. Clicking on this button will redirect you to the settings page which will allow you to update your plan. Alternatively, click 'Plans' in column on the left.
On arriving on this page, you will be able to view your current supply scope plan. To create a plan, click on the “Update your plan” button.
Selecting your base Plan and optional Features
The prices are displayed on the right-hand-side of each plan. Each plan gives a description of how many parts can be returned from queries per month. First you will need to choose a plan. Here is a page where you can Compare Plans.
If you would like to have a unique plan (Enterprise plan), you can fill in our Questionnaire. In this guide, the basic 50K plan will be chosen.
After you have chosen your plan, you are able to choose additional features.
Each additional feature will have an additional price which will be added to the total displayed at the bottom right hand side of the page. In this guide, the additional features: “Tech specs” and “Lifecycle status” will be chosen.
If you were previously on a plan and are updating it, you will see a blue info box above your total letting you know that your plan will be upgraded immediately, and you will receive a refund for the unused days of your current plan.
After you have chosen any additional features that you wish to include in your plan, you will need to click on the “Next” button, located at the bottom of the screen.
Once you have clicked on "Next", billing information will need to be submitted.
Adding Billing information
Next, enter billing and payment information.
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.
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 “Apps” 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.
If you are content with the terms of use, you will need to check the box to agree to the terms of service.
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 “Apps” button on the left hand column, you will be able to view all your applications, or you can click on the arrow next to the application name (“MyTestApp” 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.
The Evaluation application comes as a default with your Nexar account. It gives you a lifetime 1000 returned parts, for free.
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, click on "API playground" in the column on the left. Then, select which application you want to use - in this case the app we just created, "MyTestApp".
You can now test out some of the example queries we have in our playground, and make any edits you want to in the built-in IDE.
Exploring the Data Model
You can further explore our data model using the Voyager, and see all our Nexar Playground GraphQL Query examples.
Once you have edited your IDE, you can run the query by clicking the blue play button located at the top of 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 “MyTestApp” returned five 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!
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article