Mangabeiras API

Get Started. It's Free
or sign up with your email address
Rocket clouds
Mangabeiras API by Mind Map: Mangabeiras API

1. Sessions

1.1. sign_in

1.1.1. Request (POST)

1.1.1.1. email: string

1.1.1.2. senha: string

1.1.2. response(JSON)

1.1.2.1. success

1.1.2.1.1. jwt: token

1.1.2.2. error

1.1.2.2.1. errorMessage

1.1.2.2.2. statusCode

1.2. sign_out

1.2.1. response(JSON)

1.2.1.1. sucess

1.2.1.1.1. statusCode

1.2.1.1.2. sucessMessage

1.2.1.2. error

1.2.1.2.1. statusCode

1.2.1.2.2. errorMessage

2. user

2.1. create

2.1.1. request(POST)

2.1.1.1. name:string

2.1.1.2. email: string

2.1.1.3. cpf: integer

2.1.1.4. genre: enum

2.1.1.5. phone: integer

2.1.1.6. password: string

2.1.1.7. birthday: string

2.1.2. response(JSON)

2.1.2.1. sucess

2.1.2.2. error

2.2. update

2.2.1. response(JSON)

2.2.1.1. sucess

2.2.1.1.1. statusCode

2.2.1.1.2. sucessMessage

2.2.1.2. error

2.2.1.2.1. errorMessage

2.2.1.2.2. statusCode

2.3. update

2.3.1. request(PUT)

2.3.1.1. name:string

2.3.1.2. email: string

2.3.1.3. cpf: integer

2.3.1.4. genre: enum

2.3.1.5. phone: integer

2.3.1.6. password: string

2.3.1.7. birthday: string

3. address

3.1. create

3.1.1. request (POST)

3.1.1.1. name: string

3.1.1.2. street: string

3.1.1.3. number: integer

3.1.1.4. cep: integer

3.1.1.5. district: string

3.1.1.6. city: string

3.1.1.7. complement: string

3.1.1.8. apartment: string

3.1.1.9. reference: string

3.1.2. response (JSON)

3.1.2.1. sucess

3.1.2.1.1. statusCode

3.1.2.2. error

3.1.2.2.1. statusCode

3.1.2.2.2. errorMessage

3.2. update

3.2.1. request (PUT)

3.2.1.1. id: string

3.2.1.2. name: string

3.2.1.3. street: string

3.2.1.4. cep: integer

3.2.1.5. number: integer

3.2.1.6. district: string

3.2.1.7. city: string

3.2.1.8. complement: string

3.2.1.9. apartment: string

3.2.1.10. reference: string

3.2.2. response (JSON)

3.2.2.1. sucess

3.2.2.1.1. statusCode

3.2.2.2. error

3.2.2.2.1. statusCode

3.2.2.2.2. errorMessage

3.3. delete

3.3.1. request (DELETE)

3.3.1.1. id: integer

3.3.2. response (JSON)

3.3.2.1. sucess

3.3.2.1.1. statusCode

3.3.2.2. error

3.3.2.2.1. statusCode

3.3.2.2.2. errorMessage

3.4. index

3.4.1. request (GET)

3.4.2. response (JSON)

3.4.2.1. success

3.4.2.1.1. satusCode

3.4.2.2. error

3.4.2.2.1. statusCode

3.4.2.2.2. errorMessage

3.5. show

3.5.1. request(GET)

3.5.1.1. id: integer

3.5.2. response (JSON)

3.5.2.1. success

3.5.2.1.1. satusCode

3.5.2.2. error

3.5.2.2.1. statusCode

3.5.2.2.2. errorMessage