3. URL Design

3. URL Design

URLs for a collection of resources are formed from the resource type. For example a collection of resources of type sites will have the URL:

/api/v2/sites

Treat collections of resources as sets keyed by resource ID. The URL for an individual resource can be formed by appending the resource ID to the collection URL.

For example, a site with an ID of “1” will have the URL:

/api/v2/sites/1

A related resource URL is formed by appending the name of the relationship to the resource URL.

For example, the URL for a site API keys will be:

/api/v2/sites/1/nao_api_keys

    • Related Articles

    • List of URLs used by the SDK

      Required SDK URLs Please ensure that your network allows access to the following URLs for full functionality of the SDK: For european customers: URL Description URL for Production Environment URL for Staging Environment Distribution URL to download ...

    • Use Your Private Server

      Optionally, you can use your private server to host the configuration files (PDB(s) and app.json). To achieve that, you just need to configure theNAOServicesConfig class as follows: NAOServicesConfig.setRootURL("YOUR_SERVER_URL"); This class will be ...

    • Use Your Private Server

      Optionally, you can use your private server to host the configuration files (PDB(s) and app.json). To achieve that, you just need to configure theNAOServicesConfig class as follows: [NAOServicesConfig setRootUrl("YOUR_SERVER_URL")]; This class will ...

    • 8. Storage Related Resources

      Consider a situation when you need to create a resource that references a file (e.g: an image). The file needs to be uploaded before resource creation and after requested to get the credentials allowing you to upload to the storage service. The steps ...

    • 8. Storage Related Resources

      Consider a situation when you need to create a resource that references a file (e.g: an image). The file needs to be uploaded before resource creation and after requested to get the credentials allowing you to upload to the storage service. The steps ...