{"id":1418,"date":"2021-09-09T15:48:36","date_gmt":"2021-09-09T11:48:36","guid":{"rendered":"https:\/\/blog.keitaro.io\/en\/?p=1418"},"modified":"2024-12-02T12:03:22","modified_gmt":"2024-12-02T10:03:22","slug":"admin-api-article","status":"publish","type":"post","link":"https:\/\/blog.keitaro.io\/en\/admin-api-article\/","title":{"rendered":"Admin API in Keitaro Tracker: How to Work with It?"},"content":{"rendered":"\n

Today, let\u2019s dive into the Admin API: why it\u2019s essential, the problems it addresses, and how to correctly structure API requests for the tracker.<\/p>\n\n\n\n\n\n\n\n

Admin API Interface<\/strong><\/h2>\n\n\n\n

The Application Programming Interface (API)<\/strong> describes how one computer program can interact with another program.<\/p>\n\n\n\n

Keitaro Admin API is an interface that allows you to control the admin panel of Keitaro Tracker through incoming requests. That is, without going into the tracker admin panel, you can, for example, create a campaign with the necessary settings, change stream content, or generate a conversion report, whether it be through a server script or an external application like Postman.<\/p>\n\n\n\n

Actual Application of the Admin API<\/strong><\/h2>\n\n\n\n

The Admin API is often used when it is necessary to automate routine scripts or work with large amounts of data.<\/p>\n\n\n\n

Example A<\/strong><\/h3>\n\n\n\n

The client wants to download relevant conversions from the tracker every six hours and send the list to their CRM.<\/p>\n\n\n\n

When working through the web interface, conversions will have to be downloaded manually. Then will have to convert the received report from CSV or Excel to the required format for CRM and send it manually.<\/p>\n\n\n\n

The Admin API allows you to form a server request to receive the desired report, which can then be automatically parsed, converted, and sent to CRM. All this can be placed in one script file, which the scheduler will run every 6 hours, as specified in the condition.<\/p>\n\n\n\n

Example B<\/strong><\/h3>\n\n\n\n

Every 24 hours, the client receives a list of 100 domains that need to be added to Keitaro Tracker.<\/p>\n\n\n\n

In manual mode, the list will need to be converted to a string, where each value must be separated by a separator. After that, add the domains to the tracker.<\/p>\n\n\n\n

Using the Admin API, the list of domains will automatically be generated and can, by a server request, be added to the tracker. This task can also be executed according to a schedule or depending on a trigger event.<\/p>\n\n\n\n

How Do I Use Admin API?<\/strong><\/h2>\n\n\n\n

For simple and convenient work with the Admin API, it is desirable to have at least basic skills in working with any of the server-side languages: PHP, Node, Python, etc. But if you wish, this interface can also be mastered by a technically inexperienced person.<\/p>\n\n\n\n

In simple terms, the tracker has an entry point (a specific address) to which you send a request (the principle is similar to when you type a website address into your browser). <\/p>\n\n\n\n

Then, depending on the specified request parameters, you receive one or another response.<\/p>\n\n\n\n

To carry out this request and have it validated, you need to:<\/p>\n\n\n\n

    \n
  1. Use an authorization key (roughly speaking, your password, which will prevent third-party users from receiving information).<\/li>\n\n\n\n
  2. Use the correct query type.<\/li>\n\n\n\n
  3. Set the required parameters (needed for requests to create entities, such as creating a campaign).<\/li>\n<\/ol>\n\n\n\n

    You can get the authorization key from inside the tracker in Service \u2014> Users \u2014> Key for Admin API<\/strong>.<\/p>\n\n\n\n

    \"\"<\/figure>\n\n\n\n

    As for the query type, the following set is used when working with the Keitaro Admin API:<\/p>\n\n\n\n

    1. GET <\/strong>\u2014 to get information, for example, a list of tracker campaigns:<\/p>\n\n\n\n

    https:\/\/keitarosupport1.xyz\/admin_api\/v1\/campaigns<\/span><\/p>\n\n\n\n

    2. POST <\/strong>\u2014 for building reports, as well as for creating something, for example, a new campaign in the tracker:<\/p>\n\n\n\n

    https:\/\/keitarosupport1.xyz\/admin_api\/v1\/campaigns<\/span><\/p>\n\n\n\n

    Please note<\/strong>: the request address looks the same outwardly. In both cases, we refer to the \u201ctracker entry point,\u201d which contains:<\/p>\n\n\n\n