· 6 years ago · Oct 23, 2019, 04:14 PM
1Настройка API
2
3В меню API надо добавить новые данные через форму (Add Api Keys). Api Description - описание API, для себя.
4
5После добавления появятся следующие данные:
6Api Key - ключ аутентификации клиента
7Crypt Key - крипто ключ для крипта/декрипта данных
8Whitelist Ips - ип с которых возможно обращение к API
9
10
11---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
121. Аутентификация, проходит по auth_key (ключ авторизации Api Key) и по ip (Whitelist Ips)
132. Все данные криптуются в двухстороннем порядке:
142.1 Ответы от АПИ:
152.1.1 Ответ имеет стандартную структуру, массив со следующими ключами:
16Успешный ответ:
17[
18'STATUS' => 'SUCCESS',
19'DATA' => [] - (данные закриптованные Вашим крипто ключом crypt_key )
20]
21Неуспешный ответ:
22[
23'STATUS' => 'ERROR',
24'CODE' => '', - (код ошибки)
25'MESSAGE' => '' - (сообщение об ошибке)
26]
272.1.2 Данные ответа от API клиенту приходят в переменной DATA, которая закриптована крипто ключом клиента (crypt_key)
282.2 Запросы к АПИ:
292.2.1 В случае если посылаются данные, они закриптовываются c помощью crypt_key в переменную DATA
30
31---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
32Список штатов:
33
34 'AA', 'AB', 'AE', 'AK', 'AL', 'AP', 'AR', 'AS', 'AZ', 'CA', 'CO', 'CT', 'DC', 'DE', 'FL', 'GA', 'GU',
35 'HI', 'IA', 'ID', 'IL', 'IN', 'KS', 'KY', 'LA', 'MA', 'MD', 'ME', 'MI', 'MN', 'MO', 'MS', 'MT', 'NC', 'ND',
36 'NE', 'NH', 'NJ', 'NM', 'NV', 'NY', 'OH', 'OK', 'OR', 'PA', 'PR', 'RI', 'SC', 'SD', 'SK', 'TN', 'TX', 'UT',
37 'VA', 'VI', 'VT', 'WA', 'WI', 'WV', 'WY'
38
39
40Допустимые символы в firstname и lastname и city: Буквы, пробел и дефис [a-zA-Z\-\s]
41---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
42Методы для работы с АПИ
43
44Список методов:
451. Получение баланса - (функ. getBalance)
462. Получение цен - (функ. getPrices)
473.1 Фулки - (функ. fulls)
483.2 Получение статуса фулки - (функ. getFullsStatus)
493.3 Получение реультата фулки - (функ. getFullsResult)
504.1 Поиск - (функ. search)
514.2 Получение статуса поиска и его результата при нахождении - (функ. getSearchStatus)
524.3 Массовое получение статуса поиска и его результата при нахождении - (функ. GetSearchStatusBulk)
534.4 Получение максимального лимита sids для функции GetSearchStatusBulk - (функ. GetSearchStatusBulkLimit)
544.5 Получение реультата поиска - (функ. getResult)
554.6 Покупка результата поиска - (функ. buyResult)
565. Получение списка ошибок
57
58Домен, для отправления запросов может изменяться, поэтому далее все примеры будут с доменом domain.ru
59Примеры ответов предоставлены после декриптовки:
60
61---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
621. GetBalance - получение баланса
63
64Пример запроса:
65
66domain.ru/api/getbalance?key=4b161d1b4f31686448880c0bbc43feb2
67
68
69Пример запроса (ApiRequest):
70
71getBalance();
72
73
74Пример ответа:
75
76 Array
77(
78 [STATUS] => SUCCESS
79 [DATA] => Array
80 (
81 [BALANCE] => 12.00
82 )
83
84)
85---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
86
872. GetPrices - получение цен
88
89Пример запроса:
90
91domain.ru/api/getprices?key=4b161d1b4f31686448880c0bbc43feb2
92
93
94Пример запроса (ApiRequest):
95
96getPrices();
97
98
99Пример ответа:
100
101 Array
102(
103 [STATUS] => SUCCESS
104 [DATA] => Array
105 (
106 [SEARCH_PRICE] => 1.00
107 [FULL_SEARCH_PRICE] => 0.50
108 )
109
110)
111SEARCH_PRICE - Цена покупки результата поиска
112FULL_SEARCH_PRICE - Цена фулки
113NB! Цены могут меняться
114---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
115
1163.1 Fulls - Фулки, параметры (count, year, state, zip)
117
118Пример запроса:
119
120domain.ru/api/fulls?key=4b161d1b4f31686448880c0bbc43feb2
121и POST данные DATA=d73VsakSLXqMbTjB%2F9sha%2BQDZMcstx1bt2HlDqALY0quD7S9wijR2P3g19jHx2r5ujNtZYIO9IppqFwkWf7IHfNJwOMNt7ja%2FDsSfRjavQM%3D;
122Где DATA это следующий массив: $data['DATA'] = ['count' => 10, 'year' => 1975, 'state' => 'LA', 'zip' => 12345];
123
124
125Пример запроса (ApiRequest):
126
127@param null $count (минимум 10, максимум 1000)
128@param null $year (формат YYYY, минимум 1800, максимум сегодняшний год)
129@param null $state (2 знака, пример "LA")
130@param null $zip (5 цифр)
131
132fulls(10, 1975, 'LA', 12345);
133
134
135Пример ответа:
136
137 Array
138(
139 [STATUS] => SUCCESS
140 [DATA] => Array
141 (
142 [FID] => 8
143 )
144
145)
146FID - ID для функций GetFullsStatus и GetFullsResult
147---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
148
1493.2 GetFullsStatus - получение статуса фулки, обязательный параметр (fid)
150
151Пример запроса:
152
153domain.ru/api/getfullsstatus?key=4b161d1b4f31686448880c0bbc43feb2
154и POST данные DATA=d73VsakSLXqMbTjB%2F9sha%2BQDZMcstx1bt2HlDqALY0quD7S9wijR2P3g19jHx2r5ujNtZYIO9IppqFwkWf7IHfNJwOMNt7ja%2FDsSfRjavQM%3D;
155Где DATA это следующий массив: $data['DATA'] = ['fid' => 8];
156
157
158Пример запроса (ApiRequest):
159
160@param null $fid (int)
161getFullsStatus(8);
162
163
164Пример ответа:
165
166 Array
167(
168 [STATUS] => SUCCESS
169 [DATA] => Array
170 (
171 [STATUS] => IN PROCESS
172 )
173
174)
175DATA[STATUS] = IN PROCESS - в процессе
176DATA[STATUS] = NOT FOUND - не найден
177DATA[STATUS] = FOUND - найден
178---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
179
1803.3 GetFullsResult - получение реультата фулки, обязательный параметр (fid)
181
182Пример запроса:
183
184domain.ru/api/getfullsresult?key=4b161d1b4f31686448880c0bbc43feb2
185и POST данные DATA=d73VsakSLXqMbTjB%2F9sha%2BQDZMcstx1bt2HlDqALY0quD7S9wijR2P3g19jHx2r5ujNtZYIO9IppqFwkWf7IHfNJwOMNt7ja%2FDsSfRjavQM%3D;
186Где DATA это следующий массив: $data['DATA'] = ['fid' => 8];
187
188
189Пример запроса (ApiRequest):
190
191@param null $fid (int)
192getFullsResult(8);
193
194
195Пример ответа 1:
196
197 Array
198(
199 [STATUS] => SUCCESS
200 [DATA] => Array
201 (
202 [STATUS] => IN PROCESS
203 )
204
205)
206DATA[STATUS] = IN PROCESS - в процессе
207DATA[STATUS] = NOT FOUND - не найден
208
209Пример ответа 2:
210
211 Array
212(
213 [STATUS] => SUCCESS
214 [DATA] => ssn;firstname;middlename;lastname;address1;address2;city;state;zip;zip4;phone;dob
215 XXXXXXX;XXXXXXX;;XXXXXXX;XXXXXXX;XXXXXXX;XXXXXXX;XXXXXXX;XXXXXXX;XXXXXXX;XXXXXXX;
216 XXXXXXX;XXXXXXX;XXXXXXX;XXXXXXX;XXXXXXX;;XXXXXXX;XXXXXXX;XXXXXXX;XXXXXXX;XXXXXXX;XXXXXXX
217)
218Если найден, то DATA - формат csv
219---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
220
2214.1 Search - поиск, параметры (lastname, firstname, state, city, zip, dob, ssn)
222
223NB! Список возможных комбинаций запроса:
2241. 'state', 'firstname', 'lastname'
2252. 'city', 'firstname', 'lastname'
2263. 'zip', 'firstname', 'lastname'
2274. 'dob', 'firstname', 'lastname'
2285. 'ssn', 'lastname'
229
230Пример запроса:
231
232domain.ru/api/search?key=4b161d1b4f31686448880c0bbc43feb2
233и POST данные DATA=d73VsakSLXqMbTjB%2F9sha%2BQDZMcstx1bt2HlDqALY0quD7S9wijR2P3g19jHx2r5ujNtZYIO9IppqFwkWf7IHfNJwOMNt7ja%2FDsSfRjavQM%3D;
234Где DATA это следующий массив: $data['DATA'] = ['lastname' => 'Green', 'firstname' => 'Mike', 'zip' => 12345]; - это комбинация номер 3
235
236
237Пример запроса (ApiRequest):
238
239@param null $lastname (максимум 50 знаков)
240@param null $firstname (максимум 50 знаков)
241@param null $state (2 знака, пример "LA")
242@param null $city (максимум 50 знаков)
243@param null $zip (формат XXXXX "55555")
244@param null $dob (формат YYYY или YYYYMM или YYYYMMDD)
245@param null $ssn (формат XXXXX, пример 55555)
246
247search('Green', 'Mike', null, null, 12345, null, null);
248
249
250Пример ответа:
251
252 Array
253(
254 [STATUS] => SUCCESS
255 [DATA] => Array
256 (
257 [SID] => 7
258 )
259
260)
261SID - ID для функции GetSearchStatus или GetSearchStatusBulk
262---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
263
2644.2 GetSearchStatus - получение статуса поиска и его результата при нахождении, обязательный параметр (sid)
265
266Пример запроса:
267
268domain.ru/api/getsearchstatus?key=4b161d1b4f31686448880c0bbc43feb2
269и POST данные DATA=d73VsakSLXqMbTjB%2F9sha%2BQDZMcstx1bt2HlDqALY0quD7S9wijR2P3g19jHx2r5ujNtZYIO9IppqFwkWf7IHfNJwOMNt7ja%2FDsSfRjavQM%3D;
270Где DATA это следующий массив: $data['DATA'] = ['sid' => 7];
271
272
273Пример запроса (ApiRequest):
274
275@param null $sid (int)
276getSearchStatus(7);
277
278
279Пример ответа:
280
281 Array
282(
283 [STATUS] => SUCCESS
284 [DATA] => Array
285 (
286 [STATUS] => FOUND
287 [RESULT] => Array
288 (
289 [0] => Array
290 (
291 [ssn] => Array
292 (
293 [0] => 12345678
294 [1] => 87654321
295 )
296
297 [name] => Array
298 (
299 [0] => name1
300 [1] => name2
301 )
302
303 [dob] => Array
304 (
305 [0] => 1980/02/02
306 [1] => 1989/01/01
307 )
308
309 [address] => Array
310 (
311 [0] => addr1
312 [1] => addr2
313 )
314
315 [dob_year] => Array
316 (
317 [0] => 1980
318 [1] => 1989
319 )
320
321 [rid] => 25
322 )
323
324 [1] => Array
325 (
326 [ssn] => Array
327 (
328 [0] => 12345678
329 [1] => 87654321
330 )
331
332 [name] => Array
333 (
334 [0] => name1
335 [1] => name2
336 )
337
338 [dob] => Array
339 (
340 [0] => 1980/02/02
341 [1] => 1989/01/01
342 )
343
344 [address] => Array
345 (
346 [0] => addr1
347 [1] => addr2
348 )
349
350 [dob_year] => Array
351 (
352 [0] => 1980
353 [1] => 1989
354 )
355
356 [rid] => 26
357 )
358
359 )
360
361 )
362
363)
364rid - ID для функций GetResult и BuyResult
365---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
366
3674.3 GetSearchStatusBulk - массовое получение статуса поиска и его результата при нахождении, обязательный параметр (sids)
368
369Пример запроса:
370
371domain.ru/api/getsearchstatusbulk?key=4b161d1b4f31686448880c0bbc43feb2
372и POST данные DATA=d73VsakSLXqMbTjB%2F9sha%2BQDZMcstx1bt2HlDqALY0quD7S9wijR2P3g19jHx2r5ujNtZYIO9IppqFwkWf7IHfNJwOMNt7ja%2FDsSfRjavQM%3D;
373Где DATA это следующий массив: $data['DATA'] = ['sids' => [110,111]];
374
375
376Пример запроса (ApiRequest):
377
378@param $sids (array)
379getsearchstatusbulk([110,111]);
380
381
382Пример ответа:
383
384 Array
385(
386 [STATUS] => SUCCESS
387 [DATA] => Array
388 (
389 [110] => Array
390 (
391 [STATUS] => FOUND
392 [RESULT] => Array
393 (
394 [0] => Array
395 (
396 [ssn] => Array
397 (
398 [0] => 12345678
399 [1] => 87654321
400 )
401
402 [name] => Array
403 (
404 [0] => name1
405 [1] => name2
406 )
407
408 [dob] => Array
409 (
410 [0] => 1980/02/02
411 [1] => 1989/01/01
412 )
413
414 [address] => Array
415 (
416 [0] => addr1
417 [1] => addr2
418 )
419
420 [dob_year] => Array
421 (
422 [0] => 1980
423 [1] => 1989
424 )
425
426 [rid] => 25
427 )
428
429 [1] => Array
430 (
431 [ssn] => Array
432 (
433 [0] => 12345678
434 [1] => 87654321
435 )
436
437 [name] => Array
438 (
439 [0] => name1
440 [1] => name2
441 )
442
443 [dob] => Array
444 (
445 [0] => 1980/02/02
446 [1] => 1989/01/01
447 )
448
449 [address] => Array
450 (
451 [0] => addr1
452 [1] => addr2
453 )
454
455 [dob_year] => Array
456 (
457 [0] => 1980
458 [1] => 1989
459 )
460
461 [rid] => 26
462 )
463 )
464
465 )
466
467 [111] => Array
468 (
469 [STATUS] => IN PROCESS
470 )
471
472 )
473
474)
475rid - ID для функций GetResult и BuyResult
476---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
477
4784.4 GetSearchStatusBulkLimit - получение максимального лимита sids для функции GetSearchStatusBulk
479
480Пример запроса:
481
482domain.ru/api/getsearchstatusbulklimit?key=4b161d1b4f31686448880c0bbc43feb2
483
484
485Пример запроса (ApiRequest):
486
487getSearchStatusBulkLimit();
488
489
490Пример ответа:
491
492 Array
493(
494 [STATUS] => SUCCESS
495 [DATA] => Array
496 (
497 [LIMIT] => 10
498 )
499
500)
501---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
502
5034.5 GetResult - получение реультата поиска, обязательный параметр (rid)
504
505Пример запроса:
506
507domain.ru/api/getresult?key=4b161d1b4f31686448880c0bbc43feb2
508и POST данные DATA=d73VsakSLXqMbTjB%2F9sha%2BQDZMcstx1bt2HlDqALY0quD7S9wijR2P3g19jHx2r5ujNtZYIO9IppqFwkWf7IHfNJwOMNt7ja%2FDsSfRjavQM%3D;
509Где DATA это следующий массив: $data['DATA'] = ['rid' => 25];
510
511
512Пример запроса (ApiRequest):
513
514@param null $rid (int)
515getresult(25);
516
517
518Пример ответа:
519
520 Array
521(
522 [STATUS] => SUCCESS
523 [DATA] => Array
524 (
525 [RESULT] => Array
526 (
527 [ssn] => Array
528 (
529 [0] => 12345678
530 [1] => 87654321
531 )
532
533 [name] => Array
534 (
535 [0] => name1
536 [1] => name2
537 )
538
539 [dob] => Array
540 (
541 [0] => 1980/02/02
542 [1] => 1989/01/01
543 )
544
545 [address] => Array
546 (
547 [0] => addr1
548 [1] => addr2
549 )
550
551 [dob_year] => Array
552 (
553 [0] => 1980
554 [1] => 1989
555 )
556
557 )
558
559 )
560
561)
562---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
563
5644.6 BuyResult - покупка реультата поиска, обязательный параметр (rid)
565
566Пример запроса:
567
568domain.ru/api/buyresult?key=4b161d1b4f31686448880c0bbc43feb2
569и POST данные DATA=d73VsakSLXqMbTjB%2F9sha%2BQDZMcstx1bt2HlDqALY0quD7S9wijR2P3g19jHx2r5ujNtZYIO9IppqFwkWf7IHfNJwOMNt7ja%2FDsSfRjavQM%3D;
570Где DATA это следующий массив: $data['DATA'] = ['rid' => 25];
571
572
573Пример запроса (ApiRequest):
574
575@param null $rid (int)
576buyResult(25);
577
578
579Пример ответа:
580
581 Array
582(
583 [STATUS] => SUCCESS
584 [DATA] => Array
585 (
586 [STATUS] => BOUGHT
587 [RESULT] => Array
588 (
589 [ssn] => Array
590 (
591 [0] => 12345678
592 [1] => 87654321
593 )
594
595 [name] => Array
596 (
597 [0] => name1
598 [1] => name2
599 )
600
601 [dob] => Array
602 (
603 [0] => 1980/02/02
604 [1] => 1989/01/01
605 )
606
607 [address] => Array
608 (
609 [0] => addr1
610 [1] => addr2
611 )
612
613 [dob_year] => Array
614 (
615 [0] => 1980
616 [1] => 1989
617 )
618
619 )
620
621 )
622
623)
624DATA[STATUS] = BOUGHT - куплен
625DATA[STATUS] = ALREADY BOUGHT - уже был куплен
626---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
627
6285. GetErrorCodes - получение списка ошибок
629
630Пример запроса:
631
632domain.ru/api/geterrorcodes?key=4b161d1b4f31686448880c0bbc43feb2
633
634
635Пример запроса (ApiRequest):
636
637getErrorCodes();
638
639
640Пример ответа:
641
642 Array
643(
644 [STATUS] => SUCCESS
645 [DATA] => Array
646 (
647 [1] => Wrong url, please see manual
648 [2] => Key is empty
649 [3] => Authorization failed
650 [4] => Wrong api key
651 [5] => Ip is not in a whitelist ips range
652 [6] => Unable to get balance
653 [7] => Unknown error
654 [8] => Unable to make request, try again later
655 [9] => Limit exceeded
656 [10] => Invalid fid
657 [11] => Unable to save search, try again
658 [12] => No such combination
659 [13] => Invalid sid
660 [14] => Invalid rid
661 [15] => Unable to buy, try again later
662 [16] => Validation error
663 [17] => Encrypted post not set
664 [18] => Decryption failed
665 [19] => Json encode error, please contact support
666 [20] => Json decode error, please contact support
667 [21] => Encryption failed, please contact support
668 [22] => Sids max count: 10
669 [23] => Service temporarily unavailable
670 )
671
672)
673ключ массива DATA - код ошибки
674---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------