Zum Inhalt springen
Developer

Self Sign Up

Anmeldung / Selbstregistrierung

Login und Sitzung2 EndpunkteLogin / Self Sign Up

Startet einen neuen Selbstanmeldungsvorgang. Liefert ein Token und die Pflichtfelder.

GET/api/cp/signup/start

Antworten

200Startet einen neuen Selbstanmeldungsvorgang. Liefert ein Token und die Pflichtfelder.SelfSignUpLog

Felder anzeigen (53)
  • idinteger

    Primärschlüssel des Anmelde-Protokolleintrags. Interne ID.

  • tokenstring

    Token, das die Anmeldung identifiziert.

  • public_session_tokenstring

    Token der öffentlichen Sitzung, in der die Anmeldung erfolgt ist.

  • invite_codeSelfSignUpLogInviteCode2

    Einladungscode, der für die Anmeldung verwendet wurde.

    Felder anzeigen (8)
    • idinteger

      Primärschlüssel des Einladungscodes. Interne ID.

    • tokenstring

      Token des Einladungscodes.

    • log_book_entry_content_typestring

      Inhaltstyp des Logbuch-Eintrags, der durch den Einladungscode erstellt wird.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

  • person_first_namestring

    Vorname, der bei der Anmeldung eingetragen wurde.

  • person_last_namestring

    Bei der Anmeldung eingegebener Nachname.

  • person_emailstring

    E-Mail-Adresse, die bei der Anmeldung angegeben wurde.

  • person_phonestring

    Bei der Anmeldung erfasste Telefonnummer.

  • company_namestring

    Bei der Anmeldung eingegebener Unternehmensname.

  • company_emailstring

    Bei der Anmeldung eingegebene E-Mail-Adresse des Unternehmens.

  • company_phonestring

    Bei der Anmeldung eingegebene Telefonnummer des Unternehmens.

  • company_addressstring

    Adresse des Unternehmens als Text.

  • company_address_street_levelstring

    Straße und Hausnummer der Unternehmensadresse.

  • company_address_costring

    Care-of-Zeile der Unternehmensadresse.

  • company_address_citystring

    Ort der Unternehmensadresse.

  • company_address_zipstring

    Postleitzahl der Unternehmensadresse.

  • company_address_countrystring

    Land der Unternehmensadresse.

  • person_addressstring

    Adresse der Person als Text.

  • person_address_street_levelstring

    Straße und Hausnummer der Personenadresse.

  • person_address_costring

    Care-of-Zeile der Personenadresse.

  • person_address_citystring

    Ort der Personenadresse.

  • person_address_zipstring

    Postleitzahl der Personenadresse.

  • person_address_countrystring

    Land der Personenadresse.

  • person_birthdaystring (date-time)

    Bei der Anmeldung erfasstes Geburtsdatum.

  • person_genderstring

    Geschlecht, das bei der Anmeldung eingetragen wurde.

  • person_grade_levelinteger

    Klassenstufe, die bei der Anmeldung eingetragen wurde.

  • person_school_classstring

    Im Anmeldeformular angegebene Schulklasse.

  • person_categorystring

    Personenkategorie, die bei der Anmeldung angegeben wurde.

  • ticket_ticket_typestring

    Durch die Anmeldung angelegte Ticketart.

  • ticket_issuetypestring

    Ein Typ wie Bug, Task, Story

  • ticket_issue_categorystring

    Eine Kategorie wie Website, Hosting, Marketing

  • require_sepaboolean

    Ob ein SEPA-Mandat erforderlich ist.

  • require_addressboolean

    Ob eine Adresse erforderlich ist.

  • require_company_namestring

    Ob ein Firmenname erforderlich ist.

  • require_person_addressboolean

    Ob eine Personenadresse erforderlich ist.

  • require_person_birthdayboolean

    Ob ein Geburtstag erforderlich ist.

  • require_person_genderboolean

    Ob ein Geschlecht erforderlich ist.

  • require_person_phonestring

    Ob eine Telefonnummer erforderlich ist.

  • require_ticketboolean

    Ob ein Ticket erforderlich ist.

  • additional_peoplearray<SelfSignUpLogAdditionalPerson>

    Weitere Personen, die in derselben Anmeldung erfasst sind.

    Felder anzeigen (22)
    • idinteger

      Primärschlüssel der weiteren Person. Interne ID.

    • person_first_namestring

      Vorname der zusätzlichen Person.

    • person_last_namestring

      Nachname der weiteren Person.

    • person_emailstring

      E-Mail-Adresse der zusätzlichen Person.

    • person_phonestring

      Telefonnummer der weiteren Person.

    • person_addressstring

      Adresse der weiteren Person als Text.

    • person_address_street_levelstring

      Straße und Hausnummer der Adresse der weiteren Person.

    • person_address_costring

      Care-of-Zeile der Adresse der weiteren Person.

    • person_address_citystring

      Ort der Adresse der weiteren Person.

    • person_address_zipstring

      Postleitzahl der Adresse der weiteren Person.

    • person_address_countrystring

      Land der Adresse der weiteren Person.

    • person_birthdaystring (date-time)

      Geburtstag der weiteren Person.

    • person_genderstring

      Geschlecht der zusätzlichen Person.

    • person_grade_levelinteger

      Klassenstufe der zusätzlichen Person.

    • person_school_classstring

      Schulklasse der weiteren Person.

    • person_categorystring

      Kategorie der weiteren Person.

    • ticket_ticket_typestring

      Ticketart für das Ticket der weiteren Person.

    • ticket_issuetypestring

      Ticket-Typ für das Ticket der weiteren Person.

    • ticket_issue_categorystring

      Ticket-Kategorie für das Ticket der weiteren Person.

    • ticket_headlinestring

      Überschrift des Tickets der zusätzlichen Person.

    • ticket_descriptionstring

      Beschreibung des zusätzlichen Personentickets.

    • processed_person_idstring

      ID der Person, die für die zusätzliche Person angelegt wurde.

  • processed_company_numberstring

    Nummer der aus der Anmeldung erzeugten Firma.

  • processed_company_idstring

    ID der Firma, die aus der Anmeldung erzeugt wurde.

  • processed_person_idstring

    ID der Person, die aus der Anmeldung angelegt wurde.

  • processed_user_idstring

    ID des Benutzers, der aus der Anmeldung angelegt wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • payment_ownerstring

    Kontoinhaber der Lastschrift.

  • payment_institutionstring

    Name der Bank des Lastschrifteinzugs.

  • payment_bicstring

    BIC des Bankkontos.

  • payment_ibanstring

    IBAN des Bankkontos.

  • payment_mandatestring

    Referenz des SEPA-Mandats.

  • payment_mandate_sign_datestring (date-time)

    Datum, an dem das SEPA-Mandat unterschrieben wurde.

  • payment_mandate_valid_until_datestring (date-time)

    Datum, bis zu dem das SEPA-Mandat gültig ist.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/signup/start
Antwort 200 application/json
{
  "id": 42,
  "person_first_name": "Beispiel",
  "person_last_name": "Beispiel",
  "person_email": "lena.hartmann@example.org",
  "person_phone": "+49 511 123456",
  "company_name": "Beispiel",
  "company_email": "lena.hartmann@example.org",
  "company_phone": "+49 511 123456",
  "company_address_city": "Hannover",
  "company_address_zip": "30163"
}

Selbstregistrierung abschließen. Erfordert Token aus Selbstregistrierung - Start.

POST/api/cp/signup/finish/{token}

Pfad-Parameter

tokenPflichtstring

Request-Body application/json

  • dataSelfSignUpLog2
    Felder anzeigen (35)
    • person_first_namestring

      Vorname, der bei der Anmeldung eingetragen wurde.

    • person_last_namestring

      Bei der Anmeldung eingegebener Nachname.

    • person_emailstring

      E-Mail-Adresse, die bei der Anmeldung angegeben wurde.

    • person_phonestring

      Bei der Anmeldung erfasste Telefonnummer.

    • company_namestring

      Bei der Anmeldung eingegebener Unternehmensname.

    • company_emailstring

      Bei der Anmeldung eingegebene E-Mail-Adresse des Unternehmens.

    • company_phonestring

      Bei der Anmeldung eingegebene Telefonnummer des Unternehmens.

    • company_addressstring

      Adresse des Unternehmens als Text.

    • company_address_street_levelstring

      Straße und Hausnummer der Unternehmensadresse.

    • company_address_costring

      Care-of-Zeile der Unternehmensadresse.

    • company_address_citystring

      Ort der Unternehmensadresse.

    • company_address_zipstring

      Postleitzahl der Unternehmensadresse.

    • company_address_countrystring

      Land der Unternehmensadresse.

    • person_addressstring

      Adresse der Person als Text.

    • person_address_street_levelstring

      Straße und Hausnummer der Personenadresse.

    • person_address_costring

      Care-of-Zeile der Personenadresse.

    • person_address_citystring

      Ort der Personenadresse.

    • person_address_zipstring

      Postleitzahl der Personenadresse.

    • person_address_countrystring

      Land der Personenadresse.

    • person_birthdaystring (date-time)

      Bei der Anmeldung erfasstes Geburtsdatum.

    • person_genderstring

      Geschlecht, das bei der Anmeldung eingetragen wurde.

    • person_grade_levelinteger

      Klassenstufe, die bei der Anmeldung eingetragen wurde.

    • person_school_classstring

      Im Anmeldeformular angegebene Schulklasse.

    • person_categorystring

      Personenkategorie, die bei der Anmeldung angegeben wurde.

    • ticket_ticket_typestring

      Durch die Anmeldung angelegte Ticketart.

    • ticket_issuetypestring

      Ein Typ wie Bug, Task, Story

    • ticket_issue_categorystring

      Eine Kategorie wie Website, Hosting, Marketing

    • additional_peoplearray<SelfSignUpLogAdditionalPerson2>

      Weitere Personen, die in derselben Anmeldung erfasst sind.

    • payment_ownerstring

      Kontoinhaber der Lastschrift.

    • payment_institutionstring

      Name der Bank des Lastschrifteinzugs.

    • payment_bicstring

      BIC des Bankkontos.

    • payment_ibanstring

      IBAN des Bankkontos.

    • payment_mandatestring

      Referenz des SEPA-Mandats.

    • payment_mandate_sign_datestring (date-time)

      Datum, an dem das SEPA-Mandat unterschrieben wurde.

    • payment_mandate_valid_until_datestring (date-time)

      Datum, bis zu dem das SEPA-Mandat gültig ist.

Antworten

200Selbstregistrierung abschließen. Erfordert Token aus Selbstregistrierung - Start.SelfSignUpLog

Felder anzeigen (53)
  • idinteger

    Primärschlüssel des Anmelde-Protokolleintrags. Interne ID.

  • tokenstring

    Token, das die Anmeldung identifiziert.

  • public_session_tokenstring

    Token der öffentlichen Sitzung, in der die Anmeldung erfolgt ist.

  • invite_codeSelfSignUpLogInviteCode2

    Einladungscode, der für die Anmeldung verwendet wurde.

    Felder anzeigen (8)
    • idinteger

      Primärschlüssel des Einladungscodes. Interne ID.

    • tokenstring

      Token des Einladungscodes.

    • log_book_entry_content_typestring

      Inhaltstyp des Logbuch-Eintrags, der durch den Einladungscode erstellt wird.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

  • person_first_namestring

    Vorname, der bei der Anmeldung eingetragen wurde.

  • person_last_namestring

    Bei der Anmeldung eingegebener Nachname.

  • person_emailstring

    E-Mail-Adresse, die bei der Anmeldung angegeben wurde.

  • person_phonestring

    Bei der Anmeldung erfasste Telefonnummer.

  • company_namestring

    Bei der Anmeldung eingegebener Unternehmensname.

  • company_emailstring

    Bei der Anmeldung eingegebene E-Mail-Adresse des Unternehmens.

  • company_phonestring

    Bei der Anmeldung eingegebene Telefonnummer des Unternehmens.

  • company_addressstring

    Adresse des Unternehmens als Text.

  • company_address_street_levelstring

    Straße und Hausnummer der Unternehmensadresse.

  • company_address_costring

    Care-of-Zeile der Unternehmensadresse.

  • company_address_citystring

    Ort der Unternehmensadresse.

  • company_address_zipstring

    Postleitzahl der Unternehmensadresse.

  • company_address_countrystring

    Land der Unternehmensadresse.

  • person_addressstring

    Adresse der Person als Text.

  • person_address_street_levelstring

    Straße und Hausnummer der Personenadresse.

  • person_address_costring

    Care-of-Zeile der Personenadresse.

  • person_address_citystring

    Ort der Personenadresse.

  • person_address_zipstring

    Postleitzahl der Personenadresse.

  • person_address_countrystring

    Land der Personenadresse.

  • person_birthdaystring (date-time)

    Bei der Anmeldung erfasstes Geburtsdatum.

  • person_genderstring

    Geschlecht, das bei der Anmeldung eingetragen wurde.

  • person_grade_levelinteger

    Klassenstufe, die bei der Anmeldung eingetragen wurde.

  • person_school_classstring

    Im Anmeldeformular angegebene Schulklasse.

  • person_categorystring

    Personenkategorie, die bei der Anmeldung angegeben wurde.

  • ticket_ticket_typestring

    Durch die Anmeldung angelegte Ticketart.

  • ticket_issuetypestring

    Ein Typ wie Bug, Task, Story

  • ticket_issue_categorystring

    Eine Kategorie wie Website, Hosting, Marketing

  • require_sepaboolean

    Ob ein SEPA-Mandat erforderlich ist.

  • require_addressboolean

    Ob eine Adresse erforderlich ist.

  • require_company_namestring

    Ob ein Firmenname erforderlich ist.

  • require_person_addressboolean

    Ob eine Personenadresse erforderlich ist.

  • require_person_birthdayboolean

    Ob ein Geburtstag erforderlich ist.

  • require_person_genderboolean

    Ob ein Geschlecht erforderlich ist.

  • require_person_phonestring

    Ob eine Telefonnummer erforderlich ist.

  • require_ticketboolean

    Ob ein Ticket erforderlich ist.

  • additional_peoplearray<SelfSignUpLogAdditionalPerson>

    Weitere Personen, die in derselben Anmeldung erfasst sind.

    Felder anzeigen (22)
    • idinteger

      Primärschlüssel der weiteren Person. Interne ID.

    • person_first_namestring

      Vorname der zusätzlichen Person.

    • person_last_namestring

      Nachname der weiteren Person.

    • person_emailstring

      E-Mail-Adresse der zusätzlichen Person.

    • person_phonestring

      Telefonnummer der weiteren Person.

    • person_addressstring

      Adresse der weiteren Person als Text.

    • person_address_street_levelstring

      Straße und Hausnummer der Adresse der weiteren Person.

    • person_address_costring

      Care-of-Zeile der Adresse der weiteren Person.

    • person_address_citystring

      Ort der Adresse der weiteren Person.

    • person_address_zipstring

      Postleitzahl der Adresse der weiteren Person.

    • person_address_countrystring

      Land der Adresse der weiteren Person.

    • person_birthdaystring (date-time)

      Geburtstag der weiteren Person.

    • person_genderstring

      Geschlecht der zusätzlichen Person.

    • person_grade_levelinteger

      Klassenstufe der zusätzlichen Person.

    • person_school_classstring

      Schulklasse der weiteren Person.

    • person_categorystring

      Kategorie der weiteren Person.

    • ticket_ticket_typestring

      Ticketart für das Ticket der weiteren Person.

    • ticket_issuetypestring

      Ticket-Typ für das Ticket der weiteren Person.

    • ticket_issue_categorystring

      Ticket-Kategorie für das Ticket der weiteren Person.

    • ticket_headlinestring

      Überschrift des Tickets der zusätzlichen Person.

    • ticket_descriptionstring

      Beschreibung des zusätzlichen Personentickets.

    • processed_person_idstring

      ID der Person, die für die zusätzliche Person angelegt wurde.

  • processed_company_numberstring

    Nummer der aus der Anmeldung erzeugten Firma.

  • processed_company_idstring

    ID der Firma, die aus der Anmeldung erzeugt wurde.

  • processed_person_idstring

    ID der Person, die aus der Anmeldung angelegt wurde.

  • processed_user_idstring

    ID des Benutzers, der aus der Anmeldung angelegt wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • payment_ownerstring

    Kontoinhaber der Lastschrift.

  • payment_institutionstring

    Name der Bank des Lastschrifteinzugs.

  • payment_bicstring

    BIC des Bankkontos.

  • payment_ibanstring

    IBAN des Bankkontos.

  • payment_mandatestring

    Referenz des SEPA-Mandats.

  • payment_mandate_sign_datestring (date-time)

    Datum, an dem das SEPA-Mandat unterschrieben wurde.

  • payment_mandate_valid_until_datestring (date-time)

    Datum, bis zu dem das SEPA-Mandat gültig ist.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/cp/signup/finish/42 \
  --header 'content-type: application/json' \
  --data '
{
  "data": {
    "person_first_name": "Beispiel",
    "person_last_name": "Beispiel",
    "person_email": "lena.hartmann@example.org",
    "person_phone": "+49 511 123456",
    "company_name": "Beispiel",
    "company_email": "lena.hartmann@example.org"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "person_first_name": "Beispiel",
  "person_last_name": "Beispiel",
  "person_email": "lena.hartmann@example.org",
  "person_phone": "+49 511 123456",
  "company_name": "Beispiel",
  "company_email": "lena.hartmann@example.org",
  "company_phone": "+49 511 123456",
  "company_address_city": "Hannover",
  "company_address_zip": "30163"
}