API Documentation | ICD Server

User Routes

User Account

POST /api/register

Public

Register

Request Body Schema

{
    "fullName": "John Doe",
    "email": "user@example.com",
    "password": "secret_password",
    "country": "US"
}

POST /api/login

Public

Login

Request Body Schema

{
    "email": "user@example.com",
    "password": "secret_password"
}

POST /api/email/verify

Public

Verify Email

Request Body Schema

{
    "email": "user@example.com",
    "code": "123456"
}

GET /api/email/verify

Public

Verify Email By Link

No specific JSON payload required

POST /api/email/resend

Public

Resend Verification Code

Request Body Schema

{
    "email": "user@example.com"
}

POST /api/forgot-password

Public

Forgot Password

Request Body Schema

{
    "email": "user@example.com"
}

GET /api/password/reset

Public

Reset Password By Link

No specific JSON payload required

POST /api/reset-password

Public

Reset Password

Request Body Schema

{
    "email": "user@example.com",
    "token": "token_string_here",
    "password": "secret_password"
}

POST /api/logout

Protected

Logout

No specific JSON payload required

POST /api/change-password

Protected

Change Password

No specific JSON payload required

POST /api/profile

Protected

Update Profile

Request Body Schema

{
    "fullName": "John Doe",
    "email": "user@example.com",
    "country": "US"
}

GET /api/profile

Protected

Get Profile

No specific JSON payload required

GET /api/requests

Protected

Index

Query Parameters

{
    "search": "string",
    "status": "string",
    "startDate": "2024-01-01",
    "endDate": "2024-01-01",
    "page": 123,
    "per_page": 123
}

GET /api/requests/{id}

Protected

Show

No specific JSON payload required

GET /api/requests/ref/{ref}

Protected

Show By Ref

No specific JSON payload required

GET /api/requests/{id}/proposals

Protected

Index

No specific JSON payload required

POST /api/proposals/{id}/select

Protected

Select

No specific JSON payload required

POST /api/requests/{id}/confirm-payment

Protected

Confirm Payment

No specific JSON payload required

GET /api/missions/{id}

Protected

Show

No specific JSON payload required

POST /api/missions/{id}/validate

Protected

Validate

No specific JSON payload required

GET /api/missions/{id}/messages

Protected

Get Messages

No specific JSON payload required

POST /api/missions/{id}/messages

Protected

Send Message

No specific JSON payload required

GET /api/missions/{id}/proofs

Protected

Get Proofs

No specific JSON payload required

POST /api/missions/{id}/proofs

Protected

Submit Proof

No specific JSON payload required

GET /api/espace-client/missions/{id}

Protected

Show

No specific JSON payload required

POST /api/espace-client/missions/{id}/validate

Protected

Validate

No specific JSON payload required

POST /api/espace-client/missions/{id}/rate

Protected

Rate

No specific JSON payload required

POST /api/espace-client/missions/{id}/payment

Protected

Confirm Payment

No specific JSON payload required

POST /api/prestataires/login

Public

Login

No specific JSON payload required

GET /api/prestataires/email/verify

Public

Verify Email

No specific JSON payload required

POST /api/prestataires/forgot-password

Public

Forgot Password

No specific JSON payload required

GET /api/prestataires/password/reset

Public

Reset Password By Link

No specific JSON payload required

POST /api/prestataires/reset-password

Public

Reset Password

No specific JSON payload required

GET /api/prestataires/{id}

Public

Get Provider

No specific JSON payload required

GET /api/prestataires/espace/missions

Protected

Provider Index

No specific JSON payload required

GET /api/prestataires/espace/missions/archived

Protected

Provider Archived Index

No specific JSON payload required

GET /api/prestataires/espace/demandes-disponibles

Protected

Get Invitations

No specific JSON payload required

GET /api/prestataires/espace/missions/{id}

Protected

Show

No specific JSON payload required

POST /api/prestataires/espace/missions/{id}/prise-en-charge

Protected

Take Over

No specific JSON payload required

POST /api/prestataires/espace/missions/{id}/start

Protected

Start

No specific JSON payload required

POST /api/prestataires/espace/missions/{id}/update

Protected

Update Progress

No specific JSON payload required

POST /api/prestataires/espace/missions/{id}/estimation

Protected

Submit Estimation

No specific JSON payload required

POST /api/prestataires/espace/missions/{id}/proofs

Protected

Upload Proof

No specific JSON payload required

POST /api/prestataires/espace/missions/{id}/submit-validation

Protected

Submit Proof

No specific JSON payload required

POST /api/prestataires/espace/missions/{id}/archive

Protected

Restore

No specific JSON payload required

POST /api/prestataires/espace/propositions

Protected

Submit

No specific JSON payload required

POST /api/prestataires/espace/change-password

Protected

Change Password

Request Body Schema

{
    "current_password": "secret_password",
    "new_password": "secret_password"
}

GET /api/branding

Public

Get Public Branding

No specific JSON payload required

GET /api/payment-config

Public

Get Public Payment Config

No specific JSON payload required

Admin Routes

Prefix: /admin

POST /api/admin/login

Public

Login

Request Body Schema

{
    "email": "user@example.com",
    "password": "secret_password"
}

POST /api/admin/email/verify

Public

Verify Email

Request Body Schema

{
    "email": "user@example.com",
    "code": "123456"
}

POST /api/admin/email/resend

Public

Resend Verification Code

Request Body Schema

{
    "email": "user@example.com"
}

POST /api/admin/forgot-password

Public

Forgot Password

Request Body Schema

{
    "email": "user@example.com"
}

POST /api/admin/reset-password

Public

Reset Password

Request Body Schema

{
    "email": "user@example.com",
    "token": "token_string_here",
    "password": "secret_password"
}

POST /api/admin/logout

Protected

Logout

No specific JSON payload required

POST /api/admin/change-password

Protected

Change Password

Request Body Schema

{
    "current_password": "secret_password",
    "new_password": "secret_password"
}

POST /api/admin/profile

Protected

Update Profile

Request Body Schema

{
    "fullName": "John Doe",
    "email": "user@example.com"
}

GET /api/admin/profile

Protected

Get Profile

No specific JSON payload required

GET /api/admin/providers

Protected

Index

Query Parameters

{
    "search": "string",
    "status": "string",
    "kind": "string",
    "page": 123
}

GET /api/admin/prestataires

Protected

Index

Query Parameters

{
    "search": "string",
    "status": "string",
    "kind": "string",
    "page": 123
}

GET /api/admin/providers/filters

Protected

Get Filters

No specific JSON payload required

GET /api/admin/providers/statuses

Protected

Get Statuses

No specific JSON payload required

GET /api/admin/providers/trashed

Protected

Trashed

No specific JSON payload required

POST /api/admin/providers/{id}/restore

Protected

Restore

No specific JSON payload required

PATCH /api/admin/providers/{id}/status

Protected

Update Status

Request Body Schema

{
    "status": "string",
    "reason": "string"
}

DELETE /api/admin/providers/{id}

Protected

Destroy

Request Body Schema

{
    "reason": "string"
}

POST /api/admin/prestataires/{id}/delete

Protected

Destroy

Request Body Schema

{
    "reason": "string"
}

GET /api/admin/requests/corbeille

Protected

Trashed

Query Parameters

{
    "search": "string",
    "status": "string",
    "startDate": "2024-01-01",
    "endDate": "2024-01-01",
    "page": 123,
    "per_page": 123
}

POST /api/admin/requests/{id}/restore

Protected

Restore

No specific JSON payload required

GET /api/admin/requests

Protected

Index

Query Parameters

{
    "search": "string",
    "status": "string",
    "startDate": "2024-01-01",
    "endDate": "2024-01-01",
    "page": 123,
    "per_page": 123
}

GET /api/admin/requests/{request}

Protected

Show

No specific JSON payload required

PUT /api/admin/requests/{request}

Protected

Update

No specific JSON payload required

DELETE /api/admin/requests/{request}

Protected

Destroy

No specific JSON payload required

GET /api/admin/demandes

Protected

Index

Query Parameters

{
    "search": "string",
    "status": "string",
    "startDate": "2024-01-01",
    "endDate": "2024-01-01",
    "page": 123,
    "per_page": 123
}

GET /api/admin/demandes/{demande}

Protected

Show

No specific JSON payload required

PUT /api/admin/demandes/{demande}

Protected

Update

No specific JSON payload required

DELETE /api/admin/demandes/{demande}

Protected

Destroy

No specific JSON payload required

POST /api/admin/requests/{id}/confirm-payment-receipt

Protected

Confirm Payment Receipt

No specific JSON payload required

POST /api/admin/requests/{id}/invite

Protected

Invite Providers

No specific JSON payload required

GET /api/admin/matching/{id}

Protected

Get Matches

No specific JSON payload required

POST /api/admin/missions/create

Protected

Create

No specific JSON payload required

POST /api/admin/missions/reset-devis

Protected

Reset Devis

No specific JSON payload required

POST /api/admin/missions/{id}/generate-devis

Protected

Generate Devis

No specific JSON payload required

POST /api/admin/missions/{id}/pay-advance

Protected

Pay Advance

No specific JSON payload required

POST /api/admin/missions/{id}/validate

Protected

Validate

No specific JSON payload required

POST /api/admin/missions/{id}/pay-balance

Protected

Pay Balance

No specific JSON payload required

POST /api/admin/missions/{id}/close

Protected

Close Mission

No specific JSON payload required

POST /api/admin/missions/{id}/archive

Protected

Get By Demande

No specific JSON payload required

POST /api/admin/demandes/{id}/reset-complete

Protected

Reset Complete

No specific JSON payload required

GET /api/admin/demandes/{id}/files

Protected

Get Files

No specific JSON payload required

GET /api/admin/demandes/{id}/logs

Protected

Get Logs

No specific JSON payload required

POST /api/admin/missions/{id}/validate-proofs

Protected

Validate Proofs

No specific JSON payload required

GET /api/admin/missions/{id}/proofs

Protected

Get Proofs

No specific JSON payload required

POST /api/admin/missions/{id}/rate-provider

Protected

Rate Provider

No specific JSON payload required

GET /api/admin/demandes/{id}/propositions

Protected

Index

No specific JSON payload required

POST /api/admin/propositions/{id}/accept

Protected

Accept

No specific JSON payload required

GET /api/admin/countries

Protected

Index

Query Parameters

{
    "search": "string",
    "status": "string",
    "page": 123
}

GET /api/admin/countries/{id}

Protected

Show

No specific JSON payload required

GET /api/admin/settings

Protected

Index

No specific JSON payload required

GET /api/admin/admins

Protected

List Admins

No specific JSON payload required

POST /api/admin/admins

Protected

Register

Request Body Schema

{
    "fullName": "John Doe",
    "email": "user@example.com",
    "role_id": "string"
}

PUT /api/admin/admins/{id}

Protected

Update Admin

No specific JSON payload required

PATCH /api/admin/admins/{id}/toggle-status

Protected

Toggle Status

No specific JSON payload required

POST /api/admin/admins/{id}/resend-verification

Protected

Resend Verification For Admin

No specific JSON payload required

POST /api/admin/admins/{id}/send-password-reset

Protected

Send Password Reset For Admin

No specific JSON payload required

GET /api/admin/activity-logs

Protected

Get Activity Logs

No specific JSON payload required

POST /api/admin/roles/{id}/restore

Protected

Restore

No specific JSON payload required

GET /api/admin/roles

Protected

Index

No specific JSON payload required

POST /api/admin/roles

Protected

Store

No specific JSON payload required

GET /api/admin/roles/{role}

Protected

Show

No specific JSON payload required

PUT /api/admin/roles/{role}

Protected

Update

No specific JSON payload required

DELETE /api/admin/roles/{role}

Protected

Destroy

No specific JSON payload required

POST /api/admin/countries

Protected

Store

Request Body Schema

{
    "code": "123456",
    "name": "string",
    "status": "string"
}

PUT /api/admin/countries/{country}

Protected

Update

Request Body Schema

{
    "code": "123456",
    "name": "string",
    "status": "string"
}

DELETE /api/admin/countries/{country}

Protected

Destroy

No specific JSON payload required

GET /api/admin/finance/invoices

Protected

Get Invoices

No specific JSON payload required

GET /api/admin/finance/payouts

Protected

Get Payouts

No specific JSON payload required

PATCH /api/admin/finance/payouts/{id}/paid

Protected

Mark Payout Paid

No specific JSON payload required

POST /api/admin/finance/payouts/{id}/paypal

Protected

Process Pay Pal Payout

No specific JSON payload required

GET /api/admin/finance/transactions

Protected

Get Transactions

No specific JSON payload required

GET /api/admin/finance/exchange-rates

Protected

Get Exchange Rates

No specific JSON payload required

PATCH /api/admin/exchange-rates/{id}

Protected

Update Exchange Rate

No specific JSON payload required

POST /api/admin/settings/branding

Protected

Update Branding

No specific JSON payload required

POST /api/admin/settings/smtp

Protected

Update Smtp

No specific JSON payload required

POST /api/admin/settings/payment

Protected

Update Payment

No specific JSON payload required

GET /api/admin/notifications

Protected

Index

No specific JSON payload required

PATCH /api/admin/notifications/{id}

Protected

Mark As Read

No specific JSON payload required

POST /api/admin/notifications/mark-all-read

Protected

Mark All As Read

No specific JSON payload required

GET /api/test-admin-requests

Public

Index

Query Parameters

{
    "search": "string",
    "status": "string",
    "startDate": "2024-01-01",
    "endDate": "2024-01-01",
    "page": 123,
    "per_page": 123
}

GET /api/admin/dashboard/stats

Public

Get Stats

No specific JSON payload required

GET /api/admin/pending-actions

Public

Get Pending Actions

No specific JSON payload required

Common Routes

Public Utility

GET /api/countries

Public

Get Countries

No specific JSON payload required

GET /api/service-categories

Public

Get Specialties

No specific JSON payload required

GET /api/provider-types

Public

Get Provider Types

No specific JSON payload required

GET /api/specialties

Public

Get Specialties

No specific JSON payload required

POST /api/files/upload

Public

Store

No specific JSON payload required

Finance Routes

Commissions

GET /api/admin/commission-configs

Protected

Index

No specific JSON payload required

POST /api/admin/commission-configs

Protected

Store

No specific JSON payload required

GET /api/admin/commission-configs/{commission_config}

Protected

Show

No specific JSON payload required

PUT /api/admin/commission-configs/{commission_config}

Protected

Update

No specific JSON payload required

DELETE /api/admin/commission-configs/{commission_config}

Protected

Destroy

No specific JSON payload required

Provider Routes

Prefix: /providers

POST /api/providers/register

Public

Register

Request Body Schema

{
    "providerType": "string",
    "companyName": "string",
    "contactName": "string",
    "email": "user@example.com",
    "phone": "string",
    "password": "secret_password",
    "address": "string",
    "city": "string",
    "country": "US",
    "specialties": "string",
    "serviceAreas": "string",
    "certifications": "string",
    "experienceYears": 123,
    "pricingType": "string",
    "description": "string",
    "document": "string"
}

POST /api/providers/login

Public

Login

No specific JSON payload required

GET /api/providers/profile

Protected

Get Profile

No specific JSON payload required

GET /api/providers/missions

Protected

Provider Index

No specific JSON payload required

GET /api/providers/invitations

Protected

Get Invitations

No specific JSON payload required

GET /api/providers/espace/missions

Protected

Provider Index

No specific JSON payload required

GET /api/providers/espace/missions/archived

Protected

Provider Archived Index

No specific JSON payload required

GET /api/providers/espace/demandes-disponibles

Protected

Get Invitations

No specific JSON payload required

GET /api/providers/espace/missions/{id}

Protected

Show

No specific JSON payload required

POST /api/providers/espace/missions/{id}/prise-en-charge

Protected

Take Over

No specific JSON payload required

POST /api/providers/espace/missions/{id}/start

Protected

Start

No specific JSON payload required

POST /api/providers/espace/missions/{id}/update

Protected

Update Progress

No specific JSON payload required

POST /api/providers/espace/missions/{id}/submit-validation

Protected

Submit Proof

No specific JSON payload required

POST /api/providers/espace/propositions

Protected

Submit

No specific JSON payload required

POST /api/providers/espace/change-password

Protected

Change Password

Request Body Schema

{
    "current_password": "secret_password",
    "new_password": "secret_password"
}

GET /api/providers/missions/{id}

Protected

Show

No specific JSON payload required

POST /api/providers/missions/{id}/progress

Protected

Update Progress

No specific JSON payload required

POST /api/providers/missions/{id}/proof

Protected

Submit Proof

No specific JSON payload required

GET /api/providers/missions/{id}/messages

Protected

Get Messages

No specific JSON payload required

POST /api/providers/missions/{id}/messages

Protected

Send Message

No specific JSON payload required

POST /api/providers/proposals

Protected

Submit

No specific JSON payload required

GET /api/providers/proposals

Protected

Index

No specific JSON payload required

GET /api/providers/proposals/{id}

Protected

Show

No specific JSON payload required