8 maja 2017

Testowe API

Do pobierania danych firm oraz sprawdzania statusu podmiotu w VAT oraz w systemie VIES

Dla wszystkich chętnych osób, chcących przetestować działanie udostępnionych bibliotek, wtyczek oraz dodatku do Microsoft Excel zostało udostępnione testowe API pod adresem: https://www.nip24.pl/api-test

Skorzystanie z testowego API nie wymaga zakładania konta w serwisie nip24.pl, a wszystkie funkcje testowego API działają w dokładnie taki sam sposób jak w przypadku API produkcyjnego (https://www.nip24.pl/api). Jedynym ograniczeniem jest zakres numerów NIP, REGON, KRS oraz IBAN o jakie można wysyłać zapytania.

Zapytania wysyłane na adres api-test mogą dotyczyć wyłącznie następujących numerów przypisanych do konkretnych funkcji:

Nazwa funkcji Opis Numery NIP Numery REGON Numery KRS Numery IBAN
isActive Funkcja do sprawdzania bieżącego statusu działalności firmy 7272445205
5213003700
5252242171
7171642051
472301670
010168068
017461044
141715362
0000030897
0000070444
n/d
getInvoiceData Funkcja do pobierania podstawowych danych firmy umożliwiających prawidłowe wystawienie faktury 7272445205
5213003700
5252242171
7171642051
472301670
010168068
017461044
141715362
0000030897
0000070444
n/d
getAllData Funkcja do pobierania szczegółowych danych firmy 7272445205
5213003700
5252242171
7171642051
472301670
010168068
017461044
141715362
0000030897
0000070444
n/d
getVIESData Funkcja do potwierdzania aktywności numeru VAT EU nadanego przez dowolne z państw członkowskich Unii Europejskiej PL7272445205
PL5213003700
PL5252242171
PL7171642051
n/d n/d n/d
getVATStatus Funkcja do sprawdzania statusu podmiotu w rejestrze VAT udostępnianym w Portalu Podatkowym Ministerstwa Finansów 7272445205
5213003700
5252242171
7171642051
472301670
010168068
017461044
141715362
0000030897
0000070444
n/d
getIBANStatus Funkcja do weryfikowania numeru konta bankowego kontrahenta w wykazie podatników VAT (tzw. biała lista podatników VAT) 7272445205
5213003700
5252242171
7171642051
472301670
010168068
017461044
141715362
n/d PL17114000001527010928203867
PL19102000032736600040047813
PL63124000017766964359303930
PL49154000046458439719826658

Konfiguracja

Dla kont produkcyjnych identyfikator klucza oraz klucz generowane są przez użytkownika po zalogowaniu się na swoje konto w portalu nip24.pl. W przypadku API testowego nie ma konieczności tworzenia konta – wystarczy wykonanie konfiguracji zgodnie z poniższym opisem.

Testowe API w celu wykonania poprawnego uwierzytelnienia wymaga, aby podczas konstrukcji obiektu klienta użyć konstruktora bez parametrów. Oto przykłady dla poszczególnych bibliotek:

using nip24Library.dll;

// Utworzenie obiektu klienta usługi serwisu testowego
NIP24Client nip24 = new NIP24Client();
#include "nip24.h"

// Utworzenie obiektu klienta usługi serwisu testowego
NIP24Client* nip24 = NULL;
nip24_new_test(&nip24);
import pl.nip24.client.*;

// Utworzenie obiektu klienta usługi serwisu testowego
NIP24Client nip24 = new NIP24Client();
require_once 'NIP24/NIP24Client.php';

\NIP24\NIP24Client::registerAutoloader();

// Utworzenie obiektu klienta usługi serwisu testowego
$nip24 = new \NIP24\NIP24Client();
from nip24 import *
from pprint import pprint

# Utworzenie obiektu klienta usługi serwisu testowego
nip24 = NIP24Client()
' Utworzenie obiektu klienta usługi serwisu testowego
Dim nip24 As New NIP24Client
# Utworzenie obiektu klienta usługi serwisu testowego
=NIP24.POŁĄCZ.TEST()

Wykorzystanie

Sprawdzenie poszczególnych funkcjonalności testowego API polega na wywołaniu poszczególnych funkcji opisanych szczegółowo na stronie dokumentacja z parametrami (numerami NIP, REGON, KRS, IBAN) wymienionymi powyżej.

Każda z udostępnianych przez nas bibliotek zawiera kod źródłowy przykładowego programu o nazwie example, który obrazuje prawidłowe użycie wszystkich funkcji API.