How To Create a Public Access API

The below article details how you create a public access API

 
This is an example of the code that is required to access the API via json. We have included a step-by-step example below, to give you an idea of how this works.
 

1. This is an Example dataset. you will need to have the dataset you want to create the API for already built in Configur

Screenshot of: This is an Example dataset. you will need to have the dataset you want to create the API for already built in Configur

2. When you have your dataset click projects. From there, you can either use an existing Project you have or create a new one.

Screenshot of: When you have your dataset click projects. From there, you can either use an existing Project you have or create a new one.

3. In your project Click "Datasets" to add your target dataset to the project. If your dataset is already in the project, ignore this step.

Screenshot of: In your project Click "Datasets" to add your target dataset to the project. If your dataset is already in the project, ignore this step.

4. Click here and select your target dataset, then, the save icon in the bottom right of your screen.

Screenshot of: Click here and select your target dataset, then, the save icon in the bottom right of your screen.

5. Now, select the API option on the left hand side.

Screenshot of: Now, select the API option on the left hand side.

6. Click 'Add API'.

Screenshot of: Click 'Add API'.

7. Name your API here.

Screenshot of: Name your API here.

8. Then click 'Continue to Dataset'.

Screenshot of: Then click 'Continue to Dataset'.

9. Now you want to select your target dataset from the available options.

Screenshot of: Now you want to select your target dataset from the available options.

10. In this example, we are selecting the Create (POST) option.

Screenshot of: In this example, we are selecting the Create (POST) option.

11. Ensure Endpoint Active is selected.

Screenshot of: Ensure Endpoint Active is selected.

12. Turn on public access (this can be kept off in other instances. If this option has not been selected an API key will be generated).

Screenshot of: Turn on public access (this can be kept off in other instances. If this option has not been selected an API key will be generated).

13. Click 'Create API'.

Screenshot of: Click 'Create API'.

14. Here, you can see the API we have just created.

Screenshot of: Here, you can see the API we have just created.

15. An end point for this API has now been created. As this is public access, no API key has been generated. However, if this was option has not been ticked, an API key would have been generated here.

Screenshot of: An end point for this API has now been created. As this is public access, no API key has been generated. However, if this was option has not been ticked, an API key would have been generated here.