Skip to main content

intro

Introduction​

This is a document for developers from other units connecting to Getfly CRM.Getfly API is built on RESTFull standards, allowing URL access from a browser.

Base URL​

All API access must be through the Base URL. Getfly provides submission methods via HTTP, including POST, GET, PUT, and DELETE.

The Base URL has the following format: https://yourcompany.getflycrm.com

Currently, you can access the API via HTTP or HTTPS, but we recommend using HTTPS to ensure data security.

Content-Type & Accept header​

By default, we only support Content-Type: application/json.

Authentication​

  • Getfly provides an authentication method via API Key.
  • Each customer will be issued a 30-digit key in the form of 9HzV4BkrWu26Qj6YPIbRPLvvp2kkbQ. Each request to Getfly must include this parameter in the header.
  • To get this key, you must log in to the admin account Getfly CRM > Cài đặt > Tích hợp > Tích hợp phần mềm khác > Getfly API Key

Example: X-API-KEY: 9HzV4BkrWu26Qj6YPIbRPLvvp2kkbQ

Note:

You must replace 9HzV4BkrWu26Qj6YPIbRPLvvp2kkbQ with the provided API key.Always keep this KEY secure. We will not be responsible for your data if you leak this information.

# Authentication method
# The API KEY will be passed in the header with each request
$ curl https://sandbox.getflycrm.com/api/v6/accounts
    - H 'X-API-KEY: 9HzV4BkrWu26Qj6YPIbRPLvvp2kkbQ'