.. NIC.LV EPP documentation master file, created by
   sphinx-quickstart on Mon May  2 22:11:27 2011.
   You can adapt this file completely to Your liking, but it should at least
   contain the root `toctree` directive.

NIC.LV EPP Server documentation
===============================

Contents:

.. toctree::
   :maxdepth: 2

   epp
   sandbox/overview
   session/overview
   messages/overview
   domain/overview
   contact/overview
   extensions/overview

Overview
========

The server implements version 1.0 of the EPP protocol as defined in `RFC-5730`_, domain name mapping (`RFC-5731`_) and contact objects mapping (`RFC-5733`_).

.. note ::

   Host object mapping (`RFC-5732`_) is **not** implemented as network records are attributes of each domain name in our data model (as defined in section 1.1 of `RFC-5731`_).

It is assumed that the reader is familiar with the EPP protocol and the way EPP extensions are defined.

Details of NIC.LV EPP service
-----------------------------

The live server is available at **epp.nic.lv** on the standard EPP port number 700.
Transport over TCP will be used as described in `RFC-5734`_ with TLS (Transport Layer Security) (We only support TLS 1.2 and 1.3, all previous versions are deprecated) to encrypt the traffic (currently client certificates are optional)
Service is allowed only from IP addresses, specified by the registrar when applying for the EPP account.

We have developed some simple :doc:`extensions <extensions/overview>` for contact and domain objects to meet our data collection needs.
Also, some restrictions take place - details are given in the documentation for each EPP command.

Where to begin?
---------------

**We suggest** using `Metaregistrar <https://www.metaregistrar.com/docs/>`_, it has .LV specific extensions implemented and is ready to use.

**If You already have experience with EPP as a registrar**, then it should not be hard to adjust existing software for working with .LV domain names.
You may be interested to look at :doc:`extensions <extensions/overview>` and learn about our :ref:`data model specifics <epp-data-model-diff>`.
Also, for each EPP command, the divergences from standard EPP are outlined.

**If EPP is still like an unexplored land for You**, please, take a look at :doc:`EPP protocol overview <epp>`.
Also, we strongly recommend to read the relevant RFCs and compare them with our implementation.

A :doc:`sandbox/overview` environment would provide a safe play-ground for You to develop and test Your client-side implementations.

XML examples
------------

In examples, following prefixes are used for namespaced elements:

* ``epp`` or no prefix - "urn:ietf:params:xml:ns:epp-1.0"
* ``contact`` for elements with "urn:ietf:params:xml:ns:contact-1.0" namespace (e.g. ``<contact:name>``)
* ``domain`` stands for "urn:ietf:params:xml:ns:domain-1.0" (e.g. ``<domain:ns>``)
* ``lvdomain`` as shortcut for elements defined in our extension for .lv domain names ``http://www.nic.lv/epp/schema/lvdomain-ext-1.0``
* ``lvcontact`` for extension which adds some fields to contact objects (``http://www.nic.lv/epp/schema/lvcontact-ext-1.0``)

However, in server response element namespace prefixes may be different from these - namespace of the element is defined only by it's URI.

Terminology
===========

.. glossary::

    ACE-encoded domain name
        Domain name label which is encoded using only US-ASCII symbols but originally contained also Unicode characters. Are prefixed with "xn--"

    IDN
        International Domain Name - containing non-ASCII symbols.

    NIC24 online system
        online web interface for managing domain names.

    Registrar's primary person
        legal person, having a registry-registrar agreement with NIC.LV, also, used
        as the billing contact for domain names managed by the registrar


Referenced documents and useful links
=====================================

* `RFC-5730`_ (Base EPP protocol)
* `RFC-5731`_ (EPP Domain names mapping)
* `RFC-5732`_ (EPP Host objects mapping)
* `RFC-5733`_ (EPP Contact object mapping)
* `RFC-5734`_ (EPP Transport over TCP)
* `Technical requirements for .lv domain names`_

* `Windows-1257 character set`_
* `ISO 3166 2-letter country codes`_

Indices and tables
==================

* :ref:`search`

.. include:: ref_links.rst