Breadcrumb path: Diamonds / Diamond APIs
You can access this page by clicking on Diamonds from your main menu, and Diamond APIs from the dropdown menu.
Diamond APIs Fundamental
Note: to use this module, you must first set up an account with Rapnet or VDB (Virtual Diamond Boutique). It is highly recommended that you use these Diamond Sources for all your diamond data.
In this module, you will learn how to set up an API Connection between Build and Rapnet and/or VDB. This is a necessary step for completing the integration between the CMS and these diamond sources.
Now that you have learned the fundamental ideas, you can continue walking through the process of Diamond APIs.
Diamonds - Diamond APIs
There are three main steps to using this module effectively:
- ● 1 Sign up for an account with VDB and/or Rapnet.
- ● 2 Gather the necessary API credentials.
- ● 3 Enter the API credentials into the Build CMS.
Now that you have seen the outline, you can continue with more detailed information in the first step (accounts sign-up).
(1) Sign up for an account with VDB and/or Rapnet
These two diamond sources are separate from Build and paid subscriptions with these services must be completed on your own.
- ● Rapnet. This is a diamond integration that specializes only in Natural diamonds. Visit the Rapnet website to sign up for an account.
- ● VDB (Virtual Diamond Boutique). This is a diamond integration that specializes in both Natural and Lab diamonds. Visit the VDB website to sign up for an account.
Once you have completed the account sign-up process, you can continue with the next step (Gather API credentials).
(2) Gather the necessary API credentials
From your account screen on the Rapnet and VDB websites, you can follow the online directions to obtain the necessary credentials listed below.
- ● Rapnet. These login credentials are required from Rapnet:
- Username. This is the Username for login.
- Password. This is the Password for login.
- ● VDB. These login credentials are required from VDB:
- API Key. This is the Application Protocol Index Key.
- Token. This a Token, a string of codes containing comprehensive data that identifies a specific user
After you have successfully obtained the credentials, you can continue with the next section (Enter credentials into Build CMS).
(3) Enter the API credentials into the Build CMS
-
● Rapnet:
Now that you have gathered the necessary credentials, you can reach this page by clicking on Diamonds from the main menu and Diamond APIs from the dropdown menu.
- ● 1 Rapnet. Select the Rapnet diamond source from the menu here.
- ● 2 Username. In this field, enter your Username credential obtained in the previous section.
- ● 3 Password. In this field, enter your Password credential obtained in the previous section.
- ● Save. Click the Save button after you have entered your credentials.
- ● Test my Settings. Click this Test my Settings button to check if your API credentials are correct and the connection is working properly. You will receive either a confirmation or error message.
After setting up your Rapnet API, you can continue with the next section (VDB).
-
VDB:
- ● 1 VDB. Select the VDB diamond source from the menu here.
- ● 2 Username. In this field, enter your Username credential obtained in the previous section.
- ● 3 Password. In this field, enter your Password credential obtained in the previous section.
- ● Save. Click the Save button after you have entered your credentials.
- ● Test my Settings. Click this Test my Settings button to check if your API credentials are correct and the connection is working properly. You will receive either a confirmation or error message.
Now that you have set up Diamond APIs for both Rapnet and VDB, that concludes the help manual for the Diamond APIs module.
Comments
0 comments
Please sign in to leave a comment.