A rest extension for django-invitations
Rest customizable extension for django-invitations
Supported Python versions:
Supported Django versions:
Supported DRF versions:
Make a proper setup for django-invitations.
# Add to settings.py, INSTALLED_APPS
'rest_framework',
'invitations',
'rest_invitations'
# Append to urls.py
url(r'^', include('rest_invitations.urls'))
INVITATION_SERIALIZER_READ
(default=rest_invitations.serializers.InvitationReadSerializer
)
Path. Serializer class for invitations (read)
INVITATION_SERIALIZER_WRITE
(default=rest_invitations.serializers.InvitationWriteSerializer
)
Path. Serializer class for invitations (write)
INVITATION_SERIALIZER_WRITE_BULK
(default=rest_invitations.serializers.InvitationBulkWriteSerializer
)
Path. Serializer class for invitations (bulk write)
INVITATION_API_BASE_URL
(default=invitations
)
String. Base api url.
INVITATION_SEND_URL
(default=send
)
String. Set up url on send endpoint
INVITATION_CREATE_AND_SEND_URL
(default=create-and-send
)
String. Set up url on create_and_send endpoint
INVITATION_SEND_MULTIPLE_URL
(default=send-multiple
)
String. Set up url on send_multiple endpoint
INVITATION_ACCEPT_INVITE_URL
(default=accept-invite
)
String. Set up url for accept_invitation endpoint
Invitations list
body request (create): email (string)
Invitation detail
<pk>
/ (retrieve, destroy)Invitation send
<pk>
/send/ (post)body request: None
Invitation create and send
body request: email (string)
Invitation multiple send
body request: email: list of strings
Accept invitation
<key>
/ (get)Feel free to contribute!