Терміни

• Дані користувача — дані, що були надані користувачем під час використання Hikka.
• Застосунок — унікальний ідентифікатор програми, що взаємодіє з Hikka API від імені користувача. Повинен містити базову інформацію, що дозволяє зрозуміти користувачеві, які дії виконуватиме програма з його Даними та обліковим записом.
• Скоуп токену — перелік дій, що можуть бути виконані за допомогою токену доступу.
• Токен доступу — унікальний набір символів, що надає доступ до керування обліковим записом користувача Hikka. Містить інформацію про Застосунок, що здійснив вхід, а також його Скоуп.
• Ідентифікатор застосунку — унікальний набір символів, що дозволяє відрізнити один Застосунок від іншого.
• Ключ застосунку — унікальний набір символів, що потрібен для верифікації запиту на створення Токену доступу. У ідеальному випадку повинен бути прихований, щоб не можна було скомпрометувати Застосунок.
• Бекенд сайту/застосунку — програмний код, що верифікує запит на Токен доступу, і здійснює дії над обліковим записом користувача, або його Даними.
• Посилання переспрямування — URL посилання до Бекенду сайту/застосунку, на яке користувач буде переспрямований після надання ним дозволу на авторизацію. Міститиме ідентифікатор запиту на Токен, як аргумент reference.

Реалізація авторизації

Створення Застосунку

1. Назву Застосунку — назва, що буде показувати користувачеві, під час його авторизації у Застосунку.
2. Опис Застосунку — короткий опис Застосунку, що може містити інформацію про те, які дії він здійснює над обліковим записом користувача, або його Даними.
3. Посилання переспрямування(див. Терміни → Посилання переспрямування)

Авторизація за допомогою Застосунку

1. Створити посилання на https://hikka.io/oauth з аргументами reference(Ідентифікатор застосунку) та scope(Скоупи токену, розділені за допомогою коми)
2. Спрямувати користувача на посилання з кроку 1
3. В разі дозволу користувача на авторизацію Hikka переспрямує користувача на Посилання переспрямування
4. У обробнику Посилання переспрямування потрібно верифікувати запит на Токен доступу для його отримання. Щоб верифікувати запит на Токен доступу потрібно зробити POST запит на https://api.hikka.io/auth/token з тілом запиту у json форматі, яке повинно містити request_reference(ідентифікатор запиту на Токен) та client_secret(Ключ застосунку). У випадку успішної верифікації запиту на Токен доступу Hikka API поверне Токен доступу(secret), час його створення(created) та час доки він дійсний(expiration) Майте на увазі. Токен доступу створений для Застосунку діє лише 30 хвилин після його створення. Щоб подовжити його дію потрібно використати його у будь-якому ендпоінті крім /auth/token/info. Наприклад /user/me Посилання на референс ендпоінту: https://api.hikka.io/docs#/Auth/third_party_auth_token_auth_token_post