Quick Start Guide¶

This guide will provide you with the fundamental steps to get started with our API and perform your first successful API request.

Step 1: Obtain an API Key¶

Your first step is to acquire an API key, which is essential for authenticating your API requests. Here’s how you can get your API key:

Step 1: Contact Nakisa Support through the “Customer Support” portal.
Step 2: Request an API key by creating a support ticket.
Step 3: The support team will generate the API key and provide it to you securely.

Keep your API key confidential. Treat it as a password, as it allows access to your data.

Step 2: Determine the base URL for your requests¶

The base URL is crucial for making API requests. It varies based on your client account, environment (development, production), and the specific service (e.g., real-estate, financial-suite). To determine your base URL:

Step 1: Identify your client account name (usually your company name in lowercase).
Step 2: Determine the environment (pre-prod, prod).
Step 3: Choose the service (nakisa-financial-suite, real-estate, etc.).

The URL format:
https://{client-account}.nakisa.cloud/data/{environment}/{service-name}/

Step 3: Make a Test Request¶

Using your API key and base URL, you can make a test API call. The example below retrieves a list of ERP systems configured in Nakisa Financial Organization Structure (FOS):

curl -X GET \
  "https://{base-url}/data/api/v1/erp-systems" \
  -H "x-api-key: <your-api-key>" \
  -H "Content-Type: application/json"

You should receive a 200 OK response containing a paginated list of ERP systems. If you encounter any issues, contact the Nakisa Support team.