[Stempel] Dokument informacyjny i API

[Helwetyk Romański]

Ostatnia wiadomość z poprzedniej strony wątku

1. Gdy weryfikuje się użytkownika jako mąż zaufania w stemplu, to po dokonaniu tego nie wiemy tak naprawde kogo zweryfikowaliśmy. Proponuje, aby po udanej weryfikacji automatycznie przekierowywało na stemplowy profil zweryfikowanej osoby.

Automatycznego przekierowania nie dodaję dla spójności z obsługą innych komunikatów zwracanych przez system, ale od teraz w panelu męża zaufania pokazuje się stosowna ramka z odsyłaczem prowadzącym do profilu zweryfikowanego mieszkańca. (Tak, wiem, że panel jest u dołu strony).

3. Możliwość zapytań typu np. GET z numerem paszportu które zwracało by dane o użytkowniku w formie JSON. Jest coś podobnego przy logowaniu za pomocą kodów jednorazowych, ale chodzi mi tu by takie dane były łatwiej dostępne w surowej formie.

To już było pokazywane, ale dla porządku: https://stempel.org.pl/api/paszport0.php?paszport=1000. Przy okazji poprawiłem zwracanie danych o awatarze mieszkańca.

2. Dodanie API do Stempla które umożliwiało by za pomocą “sekretu” (łopatologicznie: hasło do automatycznej weryfikacji) automatyczną weryfikację podanego przez użytkownika kodu stempla (S-XXXXXXXX). Do api zapytaniem typu POST podawali byśmy ID na “forum”, kod stempla i ww. “sekret”. W odpowiedzi dostali byśmy czy weryfikacja się powiodła oraz jakieś podstawowe jawne dane zweryfikowanej osoby. Chodźby sam numer paszportu.

A to, jeśli Matka Prokrastynacja dopuści, jutro wieczorem. Ogarnąłbym dzisiaj, ale muszę wyjść. (Jak bardzo zapytanie musi być typu POST? Wszystkie inne zapytania załatwiam GET-em).

[Tenir]

2. Dodanie API do Stempla które umożliwiało by za pomocą “sekretu” (łopatologicznie: hasło do automatycznej weryfikacji) automatyczną weryfikację podanego przez użytkownika kodu stempla (S-XXXXXXXX). Do api zapytaniem typu POST podawali byśmy ID na “forum”, kod stempla i ww. “sekret”. W odpowiedzi dostali byśmy czy weryfikacja się powiodła oraz jakieś podstawowe jawne dane zweryfikowanej osoby. Chodźby sam numer paszportu.

A to, jeśli Matka Prokrastynacja dopuści, jutro wieczorem. Ogarnąłbym dzisiaj, ale muszę wyjść. (Jak bardzo zapytanie musi być typu POST? Wszystkie inne zapytania załatwiam GET-em).

Może być i metoda GET. Tak przykładowo podałem. Jest SSL więc nie będzie to problemem.

[Helwetyk Romański]

2. Dodanie API do Stempla które umożliwiało by za pomocą “sekretu” (łopatologicznie: hasło do automatycznej weryfikacji) automatyczną weryfikację podanego przez użytkownika kodu stempla (S-XXXXXXXX). Do api zapytaniem typu POST podawali byśmy ID na “forum”, kod stempla i ww. “sekret”. W odpowiedzi dostali byśmy czy weryfikacja się powiodła oraz jakieś podstawowe jawne dane zweryfikowanej osoby. Chodźby sam numer paszportu.

A to, jeśli Matka Prokrastynacja dopuści, jutro wieczorem. Ogarnąłbym dzisiaj, ale muszę wyjść. (Jak bardzo zapytanie musi być typu POST? Wszystkie inne zapytania załatwiam GET-em).

Może być i metoda GET. Tak przykładowo podałem. Jest SSL więc nie będzie to problemem.

Kod: Zaznacz cały

https://stempel.org.pl/api/weryfikacja0.php?kod=OTRZYMANY_KOD&forum=IDENTYFIKATOR_NUMERYCZNY&klucz=TAJNY_KLUCZ_KRAJU

Klucz dla Osieka przekazałem w wiadomości prywatnej. Otrzymany kod to ciąg znaków typu „S-12345678”, identyfikator numeryczny to unikalny identyfikator numeryczny mieszkańca (najczęściej na forum, stąd nazwa zmiennej). Zwracane kody błędu:

• 400: Nie podano kodu, klucza API lub identyfikatora na forum
• 400: Błędny kod weryfikacji (zbyt krótki lub zbyt długi)
• 401: Błędny klucz API
• 403: Mieszkaniec nie istnieje
• 403: Kraj nie istnieje
• 403: Mieszkaniec już został zweryfikowany
• 218: Coś odmówiło posługi
• 200: Weryfikacja poprawna

W przypadku poprawnej weryfikacji, w JSON pojawi się zmienna o nazwie paszport i odpowiedniej wartości numerycznej.

[Tenir]

Kod: Zaznacz cały

https://stempel.org.pl/api/weryfikacja0.php?kod=OTRZYMANY_KOD&forum=IDENTYFIKATOR_NUMERYCZNY&klucz=TAJNY_KLUCZ_KRAJU

Klucz dla Osieka przekazałem w wiadomości prywatnej. Otrzymany kod to ciąg znaków typu „S-12345678”, identyfikator numeryczny to unikalny identyfikator numeryczny mieszkańca (najczęściej na forum, stąd nazwa zmiennej). Zwracane kody błędu:

• 400: Nie podano kodu, klucza API lub identyfikatora na forum
• 400: Błędny kod weryfikacji (zbyt krótki lub zbyt długi)
• 401: Błędny klucz API
• 403: Mieszkaniec nie istnieje
• 403: Kraj nie istnieje
• 403: Mieszkaniec już został zweryfikowany
• 218: Coś odmówiło posługi
• 200: Weryfikacja poprawna

W przypadku poprawnej weryfikacji, w JSON pojawi się zmienna o nazwie paszport i odpowiedniej wartości numerycznej.

Jedyna racja? Informatyzacja!

[Helwetyk Romański]

Jedyna racja? Informatyzacja!

No, to teraz poczekajmy, aż pojawi się pierwsza okazja do wykorzystania integracji… 😜 (Testowałem ile mogłem, czyli niewiele, ale „u mnie działa”).

[Tenir]

Jedyna racja? Informatyzacja!

No, to teraz poczekajmy, aż pojawi się pierwsza okazja do wykorzystania integracji… 😜 (Testowałem ile mogłem, czyli niewiele, ale „u mnie działa”).

Jak pojawi się petent do weryfikacji w OSB to chętnie wykorzystam jego kod stempla do przetestowania tego API. Czy możesz wstawić jeszcze przykładowego JSONa?

[Tenir]

Jedyna racja? Informatyzacja!

No, to teraz poczekajmy, aż pojawi się pierwsza okazja do wykorzystania integracji… 😜 (Testowałem ile mogłem, czyli niewiele, ale „u mnie działa”).

Jak pojawi się petent do weryfikacji w OSB to chętnie wykorzystam jego kod stempla do przetestowania tego API. Czy możesz wstawić jeszcze przykładowego JSONa?

Zgaduje że coś takiego:

Kod: Zaznacz cały

{
	"blad": 200,
	"paszport": 1000
}

[Helwetyk Romański]

Zgaduje że coś takiego:

Prawie. 😉

Kod: Zaznacz cały

{
   "blad":{
      "kod":400,
      "komunikat":"Nie podano kodu, klucza API lub identyfikatora na forum"
   }
}

Kod: Zaznacz cały

{
   "blad":{
      "kod":200,
      "komunikat":"Weryfikacja poprawna"
   },
   "paszport":1000
}

[Benjamin]

Ja zaś zwracam się z wnioskiem o udostępnienie endpointu z informacją o mężach zaufania. Coś w stylu:

Kod: Zaznacz cały

{ "kraj": 1234, "mezowie": [1234, 1234] }, { "kraj": 1234, "mezowie": [1234, 1234] }

Jak dodacie parametr ?kraj=1234 to już w ogóle będzie supcio!

[Sheldon Anszlus Robingren]

Ja zaś zwracam się z wnioskiem o udostępnienie endpointu z informacją o mężach zaufania. Coś w stylu:

Kod: Zaznacz cały

{ "kraj": 1234, "mezowie": [1234, 1234] }, { "kraj": 1234, "mezowie": [1234, 1234] }

Jak dodacie parametr ?kraj=1234 to już w ogóle będzie supcio!

Pozwolę sobie stworzyć taki endpoint, może mnie @Helwetyk nie zje za to. :D

Wszystkie kraje:

Kod: Zaznacz cały

https://stempel.org.pl/api/mezowie0.php

Kod: Zaznacz cały

{
"blad": {
	"kod": 200,
	"komunikat": "Poprawne zapytanie"
},
"dane": [
	{
		"kraj_id": "1",
		"kraj_numer": "297",
		"mezowie": [
			1000,
			1026,
			1017
		]
	},
	{
		"kraj_id": "2",
		"kraj_numer": "810",
		"mezowie": [
			1007
		]
	}
	...
	]
}

Jeden kraj, jako id kraju należyu podać id w stemplu, bądz numer kraju (trzy cyfrowy).

Kod: Zaznacz cały

https://stempel.org.pl/api/mezowie0.php?kraj=1

Kod: Zaznacz cały

https://stempel.org.pl/api/mezowie0.php?kraj=297

Kod: Zaznacz cały

{
	"blad": {
		"kod": 200,
		"komunikat": "Poprawne zapytanie"
	},
	"dane": [
		{
			"kraj_id": "1",
			"kraj_numer": "297",
			"mezowie": [
				1000,
				1026,
				1017
			]
		}
	]
}

[Benjamin]

Czym różni się kraj_id od kraj_numer? XD