How to Use the API

Generate Authorization Header

You’ll need to include the public_key as a Bearer token in the request header. This allows the API to identify and authorize your requests.

Header Setup:

Key: Authorization
Value: Bearer {public_key}

Make a Request

With the Authorization header ready, you can proceed to make a request. Here’s an example using curl:

curl --location 'api.skulytics.io/product?per_page=1' \
--header 'Authorization: Bearer {public_key}'

Response

If the API recognizes your public_key, it will return data based on the endpoint you are accessing.

Note:
Currently, the secret_key is not in use. Please use only the public_key for accessing the API.

Clients are unable to modify their API key directly. To request an API key change, clients must contact a skulytics administrator or staff member.

Client to Server Communication

Protection Against Account Blocking

Clients need not worry about their accounts being blocked or tagged as scrape bots. When utilizing the data appliance directly as a backend, the client's IP will be tracked to ensure legitimate use.

Rate Limit Management

Clients who reach their daily rate limit of 1000 requests can continue access by subscribing for additional requests.

Server to Server Communication

IP Domain Registration and Security

Clients who use a backend (BE) and register their IP domain must take necessary measures to protect their website from scrapers. Skulytics.io is not responsible if the client's account is labeled as a scraper bot, especially if the backend IP is identical to the registered IP domain.

Increased Limits with Internal Backend Use

Clients utilizing an internal backend (BE) and specifying the IP domain in the user table are eligible for increased daily limits. The default limit under these conditions is 4000 hits per day.

HTTPS Response

200 (OK) - Client request succeeds being processed by server.
201 (Created) - Server succeeds creating/adding resource as requested by client. 400 (Bad Request) - Client request failed to be processed due to failure of inputting validation from client. 401 (Unauthorized) - Client request failed to be processed due to unauthorized user. 403 (Forbidden) - Client request failed to be processed because of not having access to the requested resource. 404 (Not Found) - Client request failed to be processed due to unknown requested resource. 500 (Internal Server Error) - Client request failed to be processed due to error from the server (raising exception) 503 (Service Unavailable) - Client request failed to be processed due to unbearable request by server.

HTTP Methods

GET - To retrieve the data.
POST - To create a new data added to the source. PUT - To update the current data source. DELETE - To delete the data from the server.