Перейти к содержимому


Команды Api Для Раздела Клиентов

api

  • Авторизуйтесь для ответа в теме
В этой теме нет ответов

#1 support

support

    Активный участник

  • Модераторы
  • 3 683 сообщений
  • ГородМосква

Отправлено 20 Октябрь 2014 - 19:09

Назад к настройке работы через API

Примеры для сайта site.ru с ключом доступа 1234562f5a3cc1a97f164df9df55d826


Получение списка клиентов магазина


http://site.ru/api/v1/client/get_list

POST Data:

secret_key=1234562f5a3cc1a97f164df9df55d826

Вернёт последние 1000 клиентов магазина
Пример ответа от сервера:


Array

(

	[status] => ok

	[data] => Array

		(

			[0] => Array

				(

					[sites_client_id] => Array

						(

							[type] => int_unsigned_not_null

							[edit] => 

							[value] => 1408505

						)

					[sites_client_group_id] => Array

						(

							[type] => int_unsigned

							[edit] => 

							[value] => 

						)

					[sites_client_is_registered] => Array

						(

							[type] => int_unsigned_not_null

							[edit] => 

							[value] => 0

						)

					[sites_client_nb_orders] => Array

						(

							[type] => int_unsigned_not_null

							[edit] => 

							[value] => 14

						)

					[sites_client_sum_orders] => Array

						(

							[type] => float_unsigned_not_null

							[edit] => 

							[value] => 31190.00000

						)

					[sites_client_sum_orders_without_delivery] => Array

						(

							[type] => float_unsigned_not_null

							[edit] => 

							[value] => 17190.00000

						)

					[sites_client_sum_is_payment_orders] => Array

						(

							[type] => float_unsigned_not_null

							[edit] => 

							[value] => 0.00000

						)

					[sites_client_sum_is_payment_orders_without_delivery] => Array

						(

							[type] => float_unsigned_not_null

							[edit] => 

							[value] => 0.00000

						)

					[sites_client_avg_arpu] => Array

						(

							[type] => float_unsigned_not_null

							[edit] => 

							[value] => 2227.85714

						)

					[sites_client_avg_period] => Array

						(

							[type] => int_unsigned

							[edit] => 

							[value] => 5988

						)

					[sites_client_first_order_time] => Array

						(

							[type] => int_unsigned

							[edit] => 

							[value] => 1413724977

						)

					[sites_client_last_order_time] => Array

						(

							[type] => int_unsigned

							[edit] => 

							[value] => 1413808817

						)

					[sites_client_mail] => Array

						(

							[type] => str

							[edit] => 1

							[value] => 

						)

					[sites_client_name] => Array

						(

							[type] => str

							[edit] => 1

							[value] => Иванов Иван Иванович

						)

					[sites_client_phone] => Array

						(

							[type] => str

							[edit] => 1

							[value] => 79291234567

						)

					[sites_client_country] => Array

						(

							[type] => str

							[edit] => 1

							[value] => 

						)

					[sites_client_region] => Array

						(

							[type] => str

							[edit] => 1

							[value] => 

						)

					[sites_client_city] => Array

						(

							[type] => str

							[edit] => 1

							[value] => Москва

						)

					[sites_client_zip_code] => Array

						(

							[type] => str

							[edit] => 1

							[value] => 

						)

					[sites_client_addr] => Array

						(

							[type] => str

							[edit] => 1

							[value] => ул. Тверская д.8

						)

					[created_at] => Array

						(

							[type] => int_unsigned

							[edit] => 

							[value] => 1413724976

						)

					[updated_at] => Array

						(

							[type] => int_unsigned

							[edit] => 

							[value] => 1413808820

						)

				)

		)

)




Полученный список отсортирован по дате создания, сначала новые, затем старые клиенты. По умолчанию на страницу выводится по 1000 клиентов. Данное значение можно изменять с помощью параметра per_page.

Получить последние 10000 клиентов

http://site.ru/api/v1/clients/get_list

POST Data:

secret_key=1234562f5a3cc1a97f164df9df55d826

per_page=10000

В результате выполнения операции будет получено 10000 последних клиентов. Список аналогичен приведённому выше.


Получение второй страницы списка клиентов (с 1001 по 2000)

http://site.ru/api/v1/clients/get_list

POST Data:

secret_key=1234562f5a3cc1a97f164df9df55d826

page=2


Получение второй страницы списка клиентов с произвольным числом клиентов на страницу

http://site.ru/api/v1/clients/get_list

POST Data:

secret_key=1234562f5a3cc1a97f164df9df55d826

page=2

per_page=10

Покажет клиентов с 11 по 20й

Получение данных по одному клиенту
Рассмотрим на примере получения данных по клиенту, с идентификатором 1408505:

http://site.ru/api/v1/orders/get/1408505

POST Data:

secret_key=0837962f5a3cc1a97f164df9df55d826

Вернёт данные по клиенту с идентификатором 1408505
Пример ответа от сервера:

Array

(

	[status] => ok

	[data] => Array

		(

			[sites_client_id] => Array

				(

					[type] => int_unsigned_not_null

					[edit] => 

					[value] => 1408505

				)

			[sites_client_group_id] => Array

				(

					[type] => int_unsigned

					[edit] => 

					[value] => 

				)

			[sites_client_is_registered] => Array

				(

					[type] => int_unsigned_not_null

					[edit] => 

					[value] => 0

				)

			[sites_client_nb_orders] => Array

				(

					[type] => int_unsigned_not_null

					[edit] => 

					[value] => 14

				)

			[sites_client_sum_orders] => Array

				(

					[type] => float_unsigned_not_null

					[edit] => 

					[value] => 31190.00000

				)

			[sites_client_sum_orders_without_delivery] => Array

				(

					[type] => float_unsigned_not_null

					[edit] => 

					[value] => 17190.00000

				)

			[sites_client_sum_is_payment_orders] => Array

				(

					[type] => float_unsigned_not_null

					[edit] => 

					[value] => 0.00000

				)

			[sites_client_sum_is_payment_orders_without_delivery] => Array

				(

					[type] => float_unsigned_not_null

					[edit] => 

					[value] => 0.00000

				)

			[sites_client_avg_arpu] => Array

				(

					[type] => float_unsigned_not_null

					[edit] => 

					[value] => 2227.85714

				)

			[sites_client_avg_period] => Array

				(

					[type] => int_unsigned

					[edit] => 

					[value] => 5988

				)

			[sites_client_first_order_time] => Array

				(

					[type] => int_unsigned

					[edit] => 

					[value] => 1413724977

				)

			[sites_client_last_order_time] => Array

				(

					[type] => int_unsigned

					[edit] => 

					[value] => 1413808817

				)

			[sites_client_mail] => Array

				(

					[type] => str

					[edit] => 1

					[value] => 

				)

			[sites_client_name] => Array

				(

					[type] => str

					[edit] => 1

					[value] => Иванов Иван Иванович

				)

			[sites_client_phone] => Array

				(

					[type] => str

					[edit] => 1

					[value] => 79291234567

				)

			[sites_client_country] => Array

				(

					[type] => str

					[edit] => 1

					[value] => 

				)

			[sites_client_region] => Array

				(

					[type] => str

					[edit] => 1

					[value] => 

				)

			[sites_client_city] => Array

				(

					[type] => str

					[edit] => 1

					[value] => Москва

				)

			[sites_client_zip_code] => Array

				(

					[type] => str

					[edit] => 1

					[value] => 

				)

			[sites_client_addr] => Array

				(

					[type] => str

					[edit] => 1

					[value] => ул. Тверская д.8

				)

			[created_at] => Array

				(

					[type] => int_unsigned

					[edit] => 

					[value] => 1413724976

				)

			[updated_at] => Array

				(

					[type] => int_unsigned

					[edit] => 

					[value] => 1413808820

				)

		)

)


Создание нового клиента

http://site.ru/api/v1/clients/add

POST Data:

secret_key=0837962f5a3cc1a97f164df9df55d826

form[sites_client_mail]=ivaniv@gmail.com

form[sites_client_pass]=123456

form[sites_client_is_registered]=1

form[sites_client_name]=Иванов Иван Петрович

form[sites_client_phone]=+79291234568

form[sites_client_country]=Россия

form[sites_client_region]=Москва

form[sites_client_city]=Москва

form[sites_client_zip_code]=105300

form[sites_client_addr]=ул. Тверская д.9


Ответ от сервера:


Array

(

	[status] => ok

	[data] => Array

		(

			[sites_client_id] => Array

				(

					[type] => int_unsigned_not_null

					[edit] =>

					[value] => 1410968

				)

			[sites_client_group_id] => Array

				(

					[type] => int_unsigned

					[edit] =>

					[value] =>

				)

			[sites_client_is_registered] => Array

				(

					[type] => int_unsigned_not_null

					[edit] => 1

					[value] => 1

				)

			[sites_client_nb_orders] => Array

				(

					[type] => int_unsigned_not_null

					[edit] =>

					[value] => 0

				)

			[sites_client_sum_orders] => Array

				(

					[type] => float_unsigned_not_null

					[edit] =>

					[value] =>

				)

			[sites_client_sum_orders_without_delivery] => Array

				(

					[type] => float_unsigned_not_null

					[edit] =>

					[value] =>

				)

			[sites_client_sum_is_payment_orders] => Array

				(

					[type] => float_unsigned_not_null

					[edit] =>

					[value] =>

				)

			[sites_client_sum_is_payment_orders_without_delivery] => Array

				(

					[type] => float_unsigned_not_null

					[edit] =>

					[value] =>

				)

			[sites_client_avg_arpu] => Array

				(

					[type] => float_unsigned_not_null

					[edit] =>

					[value] =>

				)

			[sites_client_avg_period] => Array

				(

					[type] => int_unsigned

					[edit] =>

					[value] =>

				)

			[sites_client_first_order_time] => Array

				(

					[type] => int_unsigned

					[edit] =>

					[value] =>

				)

			[sites_client_last_order_time] => Array

				(

					[type] => int_unsigned

					[edit] =>

					[value] =>

				)

			[sites_client_mail] => Array

				(

					[type] => str

					[edit] => 1

					[value] => ivaniv@gmail.com

				)

			[sites_client_pass] => Array

				(

					[type] => str

					[edit] => 1

					[value] => ******

				)

			[sites_client_name] => Array

				(

					[type] => str

					[edit] => 1

					[value] => Иванов Иван Петрович

				)

			[sites_client_phone] => Array

				(

					[type] => str

					[edit] => 1

					[value] => 79291234568

				)

			[sites_client_country] => Array

				(

					[type] => str

					[edit] => 1

					[value] => Россия

				)

			[sites_client_region] => Array

				(

					[type] => str

					[edit] => 1

					[value] => Москва

				)

			[sites_client_city] => Array

				(

					[type] => str

					[edit] => 1

					[value] => Москва

				)

			[sites_client_zip_code] => Array

				(

					[type] => str

					[edit] => 1

					[value] => 105300

				)

			[sites_client_addr] => Array

				(

					[type] => str

					[edit] => 1

					[value] => ул. Тверская д.9

				)

			[created_at] => Array

				(

					[type] => int_unsigned

					[edit] =>

					[value] => 1413819725

				)

			[updated_at] => Array

				(

					[type] => int_unsigned

					[edit] =>

					[value] =>

				)

		)

)


Принимаемые поля:
Обязательные поля:
form[sites_client_name] - ФИО Покупателя

Не обязательные поля:
form[sites_client_mail] - email адрес
form[sites_client_pass] - пароль для входа в магазин
form[sites_client_is_registered] - считать ли клиента зарегистрированным в системе, чтобы у него была возможность входа в личный кабинет по email адресу и паролю? 1 - да, 0 - нет.

form[sites_client_phone] - телефон клиента
form[sites_client_country] - страна
form[sites_client_region] - область
form[sites_client_city] - Город
form[sites_client_zip_code] - Почтовый индекс
form[sites_client_addr] - Адрес

В случае указания form[sites_client_is_registered]=1 к списку обязательных полей добавляется следующие:
form[sites_client_mail]
form[sites_client_pass]

Обновление данных клиента
Рассмотрим на примере клиента, с номером 1410968.
Будем изменять пароль клиента на 0987654321:


http://site.ru/api/v1/clients/update/0987654321

POST Data:

secret_key=0837962f5a3cc1a97f164df9df55d826

form[sites_client_pass]=[color=#282828][font=helvetica, arial, sans-serif]0987654321[/font][/color]


Пример ответа от сервера:

Array

(

   [status] => ok

)







Темы с аналогичным тегами api

Количество пользователей, читающих эту тему: 0

0 пользователей, 0 гостей, 0 анонимных