API Тестемы может быть использован как авторами материалов (например, для управления их продажами на собственных веб-ресурсах), так и посредниками при распространения материалов, созданных другими пользователями, по согласованию с ними.
Во всех запросах к API в качестве идентификатора владельца (автора) материалов используется его адрес электронной почты, указанный при создании учетной записи в Тестеме. В роли идентификатора материала выступает его внутренний код.
При поступлении любого запроса к API система определяет статус отправителя запроса, исходя из следующих критериев:
- если запрос сделан в отношении конкретного материала, и отправитель запроса не является автором этого материала, отправителю будет присвоен статус «Посредник»;
- если запрос сделан без привязки к какому-либо материалу, и у отправителя запроса нет ни одного созданного ранее системного персонального задания, либо среди имеющихся системных персональных заданий нет ни одного задания, содержащего материал, автором которого является отправитель запроса, отправителю будет присвоен статус «Посредник»;
- в остальных случаях отправителю запроса будет присвоен статус «Автор».
Для каждого доменного имени, с URL которого впоследствии будут поступать запросы к API, необходимо получить специальный токен в разделе API-токены личного кабинета. Сделать это должен владелец URL, независимо от того, кому принадлежат материалы, которые планируется распространять посредством API. Таким образом, пользователь, который будет продавать на своем сайте собственные материалы, созданные в Тестеме, должен получить токен для этого сайта так же, как и посредник.
Помимо получения токена, для каждого материала, планируемого к реализции с использованием API, их автор должен выдать разрешение на доступ через API с URL конкретных домменых имен. Данное требование применяется как к собственным URL автора, так и к URL посредников.
В учетной записи отправителя запроса со статусом «Автор» должна быть активна подписка «ПРЕМИУМ», независимо от того, в рамках какого профиля ранее он выдал разрешение для домена, с URL которого впоследствии будут поступать запросы к API. Отправитель запроса со статусом «Посредник» может использовать API бесплатно. Однако в этом случае указанные выше требования по наличию подписки будут применяться к авторам тех материалов, доступ к которым запрашивает посредник. В случае несоблюдения данных требований запрос будет отклонен с сообщением об ошибке.
Порядок действий при подготовке к продаже собственных материалов с использованием API:
- Откройте рабочий стол преподавателя в Тестеме, предварительно убедившись, что в вашей учетной записи активна подписка «ПРЕМИУМ».
- Нажмите на кнопку действий, расположенную справа от названия материала, который вы планируете продавать на стороннем ресурсе (например, посредством собственного сайта).
- В меню действий выберите «Получать доход».
- В открывшемся окне добавьте доменное имя стороннего ресурса, с URL которого будут поступать запросы к API в отношении данного материала. Таких доменных имен может быть любое количество.
- Скопируйте код материала, нажав на кнопку справа от соответствующего поля. Данный код потребуется при запросах к API в качестве значения парамета «moduleId». После этого окно настроек API можно закрыть.
- Перейдите в раздел API-токены личного кабинета на сайте Тестемы и создайте токен для того же доменного имени, которое вы добавили в окне настроек API. В целях безопасности токен не отображается в личном кабинете, поэтому после создания его необходимо отправить себе по электронной почте, нажав на соответствующую кнопку напротив доменного имени. Токен, полученный таким образом, необходимо использовать во всех запросах к API.
- На сервере стороннего ресурса создайте и протестируйте ПО для взаимодействия с API Тестемы, руководствуясь описанием его методов и принципа работы.
Порядок действий при подготовке к продаже материалов посредником с использованием API:
действия автора материала:
- Убедитесь, что в вашей учетной записи активна подписка «ПРЕМИУМ».
- Откройте рабочий стол преподавателя в Тестеме, выбрав профиль, в котором вы являетесь администратором (отмечен значком желтого цвета в меню выбора профиля). На мобильных устройствах выбор профиля осуществляется в меню слева вверху.
- Нажмите на кнопку действий, расположенную справа от названия материала, который посредник планирует продавать на стороннем ресурсе.
- В меню действий выберите «Получать доход».
- В открывшемся окне добавьте доменное имя стороннего ресурса, с URL которого будут поступать запросы к API в отношении данного материала. Указанное доменное имя необходимо предварительно запросить у посредника.
- Скопируйте код материала, нажав на кнопку справа от соответствующего поля, и предоставьте его посреднику.
- Предоставьте посреднику свой адрес электронной почты, который вы использовали при регистрации в Тестеме.
действия посредника:
- Создайте учетную запись в Тестеме.
- Перейдите в раздел API-токены личного кабинета на сайте Тестемы и создайте токен для доменного имени, с URL которого будут поступать запросы к API. В целях безопасности токен не отображается в личном кабинете, поэтому после создания его необходимо отправить себе по электронной почте, нажав на соответствующую кнопку напротив доменного имени. Токен, полученный таким образом, необходимо использовать во всех запросах к API.
- Предоставьте автору то же доменное имя, для которого вы получили токен (ВАЖНО: сам токен предоставлять не требуется).
- Получите у автора его адрес электронной почты, а также идентификаторы (коды) всех материалов, которые вы планируете распространять.
- На сервере вашего ресурса создайте и протестируйте ПО для взаимодействия с API Тестемы, руководствуясь описанием его методов и принципа работы.
В процессе реализации материалов с баланса учетной записи автора списывается комиссия за каждую продажу. Ввиду этого, автору необходимо следить за состоянием баланса и своевременно производить его пополнение. В случае недостатка средств для списания комиссии, запросы к API Тестемы на создание системных персональных заданий будут отклонены, что может повлечь негативные последствия в отношении продаж как для автора материала, так и для посредника.