Господа, нужна помощь по API (точнее хотя бы первые шаги).
У меня нет ни cURL, ни PHP, чтобы "разобрать" и трансформировать в то, с чем умею работать :)
Мне кажется подобный "разбор" полезен будет и другим.
Если взять примитивные средства "проверки" на основе HTTP Request, то как этим API пользоваться?
Вот взять инструмент Postman, то вопросы:
тип запроса какой? (GET, POST?)
Ключ авторизации (есть APIKey и есть token), как и куда правильнее воткнуть? (в headers или в body в качестве параметра(ов)?)
название методов, это путь в URL или в параметрах боди название метода?
Сейчас все мои эксперименты выливаются в стандартный ответ с ошибкой <code>0001</code>
Такой "разбор" поможет адаптировать под другие языки программирования людям, которые не сильны в PHP, cURL.
http request
-
Щербаков Алексей Александрович
- Сообщения: 3
- Зарегистрирован: 28.10.2019 11:49
-
Игорь Архипов
- Сообщения: 80
- Зарегистрирован: 20.11.2017 13:22
Re: http request
В основном запросы типа POST.
Ключ API и токен для Basic Auth - для поля логин и пароль соответственно.
Посмотрите как выглядит task.get https://paw.pt/eAwTZafZ
Особо разбор не нужен, вы запросы в теле запроса пишете, а тот Postman может генерировать код на нужном языке.
Ключ API и токен для Basic Auth - для поля логин и пароль соответственно.
Посмотрите как выглядит task.get https://paw.pt/eAwTZafZ
Особо разбор не нужен, вы запросы в теле запроса пишете, а тот Postman может генерировать код на нужном языке.
-
Игорь Архипов
- Сообщения: 80
- Зарегистрирован: 20.11.2017 13:22
Re: http request
Хотя организацию документации по API хотелось бы видеть через OpenAPI и Swagger
-
Щербаков Алексей Александрович
- Сообщения: 3
- Зарегистрирован: 28.10.2019 11:49
Re: http request
во, уже лучше, но пока не получилось :(
Авторизация - Basic Auth - ОК, логин: APIKey, пароль токен.
А как именно передавать метод (название) и параметры, если нужны для этого метода? (в раздел params отдельными параметрами? или же в блок "Body" с типом "текст")?
и правильно ли я понимаю, что параметр "account" должен быть всегда и туда вставляю его название? (получал ошибку 0024, есть подозрение, что у меня "свой домен" и это может как-то влиять)
Вот взять пример метод: contact.getList ?
Для этого метода в параметрах запроса надо указать всё это или же в "Body" запихнуть что-то вроде:
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.getList">
<account></account>
</request>
Авторизация - Basic Auth - ОК, логин: APIKey, пароль токен.
А как именно передавать метод (название) и параметры, если нужны для этого метода? (в раздел params отдельными параметрами? или же в блок "Body" с типом "текст")?
и правильно ли я понимаю, что параметр "account" должен быть всегда и туда вставляю его название? (получал ошибку 0024, есть подозрение, что у меня "свой домен" и это может как-то влиять)
Вот взять пример метод: contact.getList ?
Для этого метода в параметрах запроса надо указать всё это или же в "Body" запихнуть что-то вроде:
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.getList">
<account></account>
</request>
-
Щербаков Алексей Александрович
- Сообщения: 3
- Зарегистрирован: 28.10.2019 11:49
Re: http request
В целом получилось, ошибка у меня была в URL запроса. надо было указать "https://apiru.planfix.ru/xml/"
И дальше в Body указать сам запрос:
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.getList">
<account>здесь название аккаунта</account>
</request>
Вообщем вдруг кому пригодится.
И как правильно подметил Игорь - Postman дает возможность "работающий" запрос сгенерить в нужный язык программирования.
И дальше в Body указать сам запрос:
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.getList">
<account>здесь название аккаунта</account>
</request>
Вообщем вдруг кому пригодится.
И как правильно подметил Игорь - Postman дает возможность "работающий" запрос сгенерить в нужный язык программирования.