Quickstart

To start using the One of None API, you need to obtain your API keys from the dashboard. Only team owners and team admins have access to the API keys management section. Follow the steps below:

1. Log in to your One of None dashboard.

   • Go to One of None Dashboard and sign in with your credentials.

2. Navigate to the API Keys section.

   • In the sidebar, select Team Settings, then click on API Keys.

3. Copy your API keys.

   • You will find two types of API keys available:
     • Client API Key: Safe for client-side operations (e.g., web applications), can be exposed in the browser.
     • Server API Key: For server-side operations, must be kept secret and never exposed publicly.
   • Click the copy icon next to the key to copy it to your clipboard.

Before you can start making requests to the API, you need to whitelist the domains that will use your API keys. Only team owners and team admins have access to this section:

1. Add your domains.

   • Enter the fully qualified domain name (e.g., https://yourwebsite.com or http://localhost:<port> for local development).
     Use wildcard subdomains like *.yourwebsite.com if you need broader access.

2. Save the changes.

   • Click the “Save” button to apply the changes.

Once you have obtained your API key and whitelisted your domains, you’re ready to make your first API request. Use the x-api-key header to authenticate your requests.

curl -X GET "https://api.oneofnone.io/v1/products" \
     -H "x-api-key: YOUR_API_KEY"

Replace YOUR_API_KEY with your actual API key to authenticate the request. If everything is set up correctly, you’ll receive a JSON response like the following:

  {
    "data": [
      {
        "attributes": {},
        "collection_id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "grade": 123,
        "id": 123,
        "image": {
          "url": "<string>"
        },
        "is_vaulted": true,
        "name": "<string>",
        "registered_at": "2023-11-07T05:31:56Z",
        "slug": "<string>",
        "status": "<string>",
        "token_id": 123,
        "updated_at": "2023-11-07T05:31:56Z",
        "video": {
          "url": "<string>"
        },
        "gallery": []
      }
    ],
    "pagination": {
      "next": "<string>",
      "prev": "<string>",
      "limit": 123,
      "offset": 123
    }
  }

If you encounter any issues, refer to the troubleshooting page.