Skip to content

Home

Jump to bottom
MartaNowaczyk edited this page Dec 29, 2022 · 4 revisions

Allegro API

Dzięki projektowi API Allegro na Githubie, możesz:

  • dowiedzieć się o zmianach, które wprowadzamy w naszym API,
  • zadać pytanie, które dotyczy tego interfejsu,
  • zaproponować sugestię - co możemy dodać lub zmienić w API,
  • zgłosić błąd.

Jak zadawać pytania i zgłaszać problemy na GitHubie?

Wejdź w zakładkę Issues, załóż nowe zgłoszenie i skorzystaj z odpowiedniego szablonu. Pamiętaj, aby w zgłoszeniu podać jak najwięcej dokładnych informacji - dzięki temu szybciej uzyskasz pomoc.

Jeżeli masz jakieś sugestie, lub chcesz je przejrzeć i zagłosować - skorzystaj z zakładki Discussions.

Czym jest API Allegro

API to usługa sieciowa, która umożliwia wymianę informacji między zasobami Allegro, a oprogramowaniem zewnętrznym. Dzięki niej możesz zintegrować własne rozwiązania z mechanizmami serwisu. W ramach API Allegro udostępniamy szereg zasobów, które odpowiadają poszczególnym funkcjom serwisu.

W Allegro korzystamy z REST API.

  • Zasoby, które udostępniliśmy w Allegro REST API opisaliśmy w dokumentacji.
  • Poradniki i przykłady wywołań w Allegro REST API znajdziecie w aktualnościach.

Nowości w API Allegro

Jeżeli chcesz być na bieżąco z nowościami w ramach naszego publicznego API:

  • przejdź na stronę Newsletter i kliknij w "Zapisz się", aby otrzymywać od nas automatyczne powiadomienia e-mail dotyczące zmian w API Allegro,
  • do naszego newslettera możesz zapisać się również na stronie Aktualności,
  • o nowościach informujemy także na GitHubie w zakładce Issues - wątki tagujemy znacznikiem [NEWS].

Zasady korzystania z forum API Allegro na GitHubie

  1. Jako zespół wsparcia publicznego API Allegro nadzorujemy i moderujemy treści umieszczane na forum API Allegro na GitHubie. Zastrzegamy sobie prawo do edytowania, usuwania (w całości lub w części), bez uprzedzenia, opublikowanych na forum treści w przypadku ich sprzeczności z obowiązującymi przepisami prawa oraz zasadami forum.

  2. Dobre praktyki:

    • nie powielaj wątków - użyj wyszukiwarki i sprawdź czy twój temat był już poruszany, być może znajdziesz od razu odpowiedź na swoje pytanie,
    • z każdym nowym tematem utwórz nowy wątek,
    • gdy chcesz zgłosić błąd, opisz szczegółowo sytuację i podaj dane, które pozwolą na weryfikację: środowisko, zasób, trace-id, commandId lub podaj pełne cURL z responsem i requestem (możesz je nam przekazać przez formularz kontaktowy - w zgłoszeniu podaj numer wątku na GitHubie),
    • nie wysyłaj wielokrotnie tej samej wiadomości (spam) lub wielu różnych wiadomości w bardzo krótkich odstępach (flooding),
    • dziel się swoją wiedzą,
    • jeśli chcesz zgłosić sugestię zmiany w API Allegro skorzystaj z zakładki Discussions.

  3. Zabrania się zamieszczania postów sprzecznych z obowiązującymi przepisami prawa, normami obyczajowymi, moralnymi i społecznymi, w szczególności zabrania się umieszczania treści, które:

    • są nieprawdziwe, wprowadzające lub mogące wprowadzać w błąd,
    • mogą naruszać prawa autorskie lub inne prawa własności intelektualnej,
    • naruszają prawa podmiotów trzecich,
    • naruszają dobra osobiste,
    • zawierają wrażliwe dane np. token dostępowy i dane osobowe (tego rodzaju treści przekaż nam przez formularz kontaktowy z dopiskiem wątku na GitHubie, którego to dotyczy),
    • są dyskryminujące (m.in. płeć, rasa, narodowość, język, religia), nawołujące do przemocy lub posiadające charakter pornograficzny,
    • są obraźliwe, wulgarne lub zawierające groźby,
    • są bezpośrednimi atakami na innych użytkowników forum,
    • nie mają związku z tematyką dyskusji prowadzonych w ramach forum,
    • zawierają rady, które mogłyby skutkować wyrządzeniem szkody lub popełnieniem czynu karalnego,
    • rozpowszechniania lub nakłaniania do pobierania wirusów komputerowych lub złośliwego/szkodliwego oprogramowania,
    • propagują ideologię polityczną, religijną lub inną.

Allegro API

Through the Allegro API project on Github, you can:

  • find out about the changes we are making to our API,
  • ask a question that relates to this interface,
  • propose a suggestion - what we can add or change in the API,
  • report a bug.

How to ask questions and report problems on GitHub?

Go to the Issues tab, create a new issue and use the appropriate template. Remember to provide as much accurate information as possible in your submission - this will allow us to help you faster.

If you have any suggestions, or want to review and vote on them - use the Discussions tab.

What is the Allegro API

API is a web service that allows exchanging of information between Allegro resources and external software. It allows you to integrate your own solutions with the mechanisms of the service. As part of the Allegro API, we provide a number of resources that correspond to the service's various functions.

At Allegro, we use the REST API.

  • The resources we have provided in Allegro REST API are described in the documentation.
  • You can find tutorials and examples of Allegro REST API requests on our devportal.

News in Allegro API

If you want to be up to date with new features in our public API:

  • go to the Newsletter page and click the "Subscribe" button, to receive automatic e-mail notifications from us regarding changes to the Allegro API,
  • you can also subscribe to our newsletter on the News page,
  • we also inform about news in API in the Issues tab on GitHub - threads are labeled with the [NEWS] tag.

Rules for using the Allegro API forum on GitHub

  1. As the Allegro API public support team, we oversee and moderate content posted on the Allegro API forum on GitHub. We reserve the right to edit, remove (in whole or in part), without notice, content published on the forum in case it conflicts with applicable laws and forum rules.

  2. Best practices:

    • don't duplicate threads - use a search tool and see if your topic has already been discussed, you may find the answer to your question right away,
    • create a new thread with each new issue,
    • when you want to report a bug, describe the situation in detail and provide data that will allow verification: environment, resource, trace-id, commandId or provide a full cURL with response and request (you can send it to us through the contact form - in the request, provide the thread number on GitHub),
    • do not send the same message repeatedly (spam) or many different messages in very short intervals (flooding),
    • share your knowledge,
    • if you want to make a suggestion for a change to the Allegro API, use the Discussions tab.

  3. It is forbidden to publish posts that are contrary to applicable law, moral and social norms. In particular, it is forbidden to publish content that:

    • are untrue, misleading, or potentially misleading,
    • may infringe copyrights or other intellectual property rights,
    • infringe the rights of third parties,
    • infringe any personal rights,
    • contain sensitive data, e.g., access token and personal information (submit this kind of content to us via the contact form - in the request, provide the thread number on GitHub),
    • discriminate (on account of sex, race, nationality, language, religion, etc.), incite violence, or contain pornographic content,
    • are offensive, vulgar or contain threats directed at third parties,
    • are direct attacks on other forum users,
    • are not related to the subject matter of the discussions held within the forum,
    • contain advice that could result in causing damage or committing an offence,
    • disseminate or solicit others to download computer viruses or malicious/harmful software,
    • conduct political, religious, or other agitation.
Clone this wiki locally