Opis projektu
PrzetłumaczoneNasza firma zbudowała API REST, które deweloperzy partnerzy używają do integracji z naszą platformą, ale obecna dokumentacja jest nieaktualna i rozproszona po wewnętrznych wiki i starych arkuszach kalkulacyjnych. Szukamy doświadczonego pisarza technicznego, który może przekształcić nasze istniejące punkty końcowe w czysty, uporządkowany dokument referencyjny, na którym deweloperzy mogą polegać bez konieczności kontaktowania się z naszym zespołem wsparcia za każdym razem, gdy utkną.
Praca obejmuje każdy publiczny punkt końcowy: jasne opisy tego, co robi każda metoda, pełne zestawienie wymaganych i opcjonalnych parametrów z typami i wartościami domyślnymi, uwierzytelnianie i obsługę błędów oraz realistyczne przykłady żądań i odpowiedzi w formacie JSON. Poza pisemną referencją chcemy interaktywnej strony testowej, na której deweloperzy partnerzy mogą wprowadzać swoje klucze, wysyłać przykładowe żądania i zobaczyć odpowiedzi na żywo bezpośrednio w przeglądarce.
Możemy zapewnić dostęp do środowiska testowego, istniejących notatek wewnętrznych oraz bezpośrednią komunikację z naszymi deweloperami backendowymi, aby wyjaśnić trudne punkty końcowe. Idealny kandydat ma praktyczne doświadczenie z API REST, JSON, schematami uwierzytelniania, takimi jak tokeny lub klucze API, oraz narzędziami do tworzenia interaktywnych dokumentów. Proszę podzielić się przykładami dokumentacji, którą wcześniej napisałeś, wraz z oszacowanym harmonogramem.
Wyniki:
— uporządkowana referencja dla wszystkich punktów końcowych i parametrów
— przykłady żądań i odpowiedzi dla każdej metody
— interaktywna strona testowa dla deweloperów partnerów
— krótki przewodnik wprowadzający dla nowych integratorów
Praca obejmuje każdy publiczny punkt końcowy: jasne opisy tego, co robi każda metoda, pełne zestawienie wymaganych i opcjonalnych parametrów z typami i wartościami domyślnymi, uwierzytelnianie i obsługę błędów oraz realistyczne przykłady żądań i odpowiedzi w formacie JSON. Poza pisemną referencją chcemy interaktywnej strony testowej, na której deweloperzy partnerzy mogą wprowadzać swoje klucze, wysyłać przykładowe żądania i zobaczyć odpowiedzi na żywo bezpośrednio w przeglądarce.
Możemy zapewnić dostęp do środowiska testowego, istniejących notatek wewnętrznych oraz bezpośrednią komunikację z naszymi deweloperami backendowymi, aby wyjaśnić trudne punkty końcowe. Idealny kandydat ma praktyczne doświadczenie z API REST, JSON, schematami uwierzytelniania, takimi jak tokeny lub klucze API, oraz narzędziami do tworzenia interaktywnych dokumentów. Proszę podzielić się przykładami dokumentacji, którą wcześniej napisałeś, wraz z oszacowanym harmonogramem.
Wyniki:
— uporządkowana referencja dla wszystkich punktów końcowych i parametrów
— przykłady żądań i odpowiedzi dla każdej metody
— interaktywna strona testowa dla deweloperów partnerów
— krótki przewodnik wprowadzający dla nowych integratorów
Teksty i tłumaczenia Gotówka, Przelew bankowy
